Skip to content

Commit 2a3532d

Browse files
committed
Improve skill discovery metadata
1 parent c7ff91f commit 2a3532d

4 files changed

Lines changed: 124 additions & 3 deletions

File tree

.codex-plugin/plugin.json

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"name": "codex-fast-proxy",
3+
"version": "0.1.0",
4+
"description": "Codex App Fast/Priority proxy for third-party OpenAI-compatible Responses API providers.",
5+
"author": {
6+
"name": "gaoguobin",
7+
"url": "https://github.com/gaoguobin"
8+
},
9+
"homepage": "https://github.com/gaoguobin/codex-fast-proxy#readme",
10+
"repository": "https://github.com/gaoguobin/codex-fast-proxy",
11+
"license": "MIT",
12+
"keywords": [
13+
"agent-skills",
14+
"codex",
15+
"openai-codex",
16+
"codex-skill",
17+
"skills",
18+
"ai-agents",
19+
"responses-api",
20+
"fast-mode",
21+
"service-tier",
22+
"openai-compatible-api"
23+
],
24+
"skills": "./skills/",
25+
"interface": {
26+
"displayName": "Codex Fast Proxy",
27+
"shortDescription": "Fast/Priority proxy for Codex App with third-party APIs.",
28+
"longDescription": "Manage a local, safety-bounded proxy and Agent Skill so Codex App users on third-party OpenAI-compatible API providers can enable, verify, benchmark, update, and uninstall the Fast/Priority path.",
29+
"developerName": "gaoguobin",
30+
"category": "Developer Tools",
31+
"capabilities": [
32+
"Local workflow",
33+
"Proxy management",
34+
"Benchmark"
35+
],
36+
"websiteURL": "https://github.com/gaoguobin/codex-fast-proxy",
37+
"privacyPolicyURL": "https://github.com/gaoguobin/codex-fast-proxy#safety-model",
38+
"termsOfServiceURL": "https://github.com/gaoguobin/codex-fast-proxy/blob/main/LICENSE",
39+
"defaultPrompt": [
40+
"Enable Codex Fast proxy.",
41+
"Show Codex Fast proxy status.",
42+
"Run Codex Fast proxy benchmark."
43+
],
44+
"brandColor": "#10A37F",
45+
"screenshots": [
46+
"./docs/assets/dashboard.png"
47+
]
48+
}
49+
}

README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ proxy fills only that missing field, keeps streaming untouched, and gives users
1111
a read-only dashboard to verify real traffic and benchmark whether their
1212
provider actually benefits from the priority lane.
1313

14-
[Chinese](#chinese) · [Install](#install) · [Dashboard](#dashboard) · [Benchmark](#benchmark) · [Change Upstream](#change-upstream) · [Update](#update) · [Uninstall](#uninstall) · [Safety](#safety-model) · [Sponsor](#sponsor)
14+
[Chinese](#chinese) · [Agent Skill](#agent-skill-and-discovery) · [Install](#install) · [Dashboard](#dashboard) · [Benchmark](#benchmark) · [Change Upstream](#change-upstream) · [Update](#update) · [Uninstall](#uninstall) · [Safety](#safety-model) · [Sponsor](#sponsor)
1515

1616
![Codex Fast Proxy dashboard](docs/assets/dashboard.png)
1717

@@ -44,6 +44,35 @@ the proxy.
4444
`service_tier="priority"`.
4545
- PackyAPI Fast / priority has been verified end to end.
4646

47+
## Agent Skill and Discovery
48+
49+
This repository includes an Agent Skill for Codex:
50+
51+
- Skill name: `codex-fast-proxy`
52+
- Skill path: `skills/codex-fast-proxy/SKILL.md`
53+
- Primary use case: let Codex App users on third-party OpenAI-compatible API providers enable,
54+
verify, benchmark, update, and uninstall the Fast / Priority path.
55+
- Safety boundary: the proxy only handles `POST /v1/responses`, injects
56+
`service_tier="priority"` only when that field is absent, and leaves `model`, `reasoning`,
57+
`tools`, `input`, request bodies, and streaming SSE frames otherwise unchanged.
58+
- Benchmark: run `python -m codex_fast_proxy benchmark` or ask Codex to run the A/B benchmark.
59+
The dashboard shows the latest saved redacted benchmark summary.
60+
61+
Tools that index public GitHub repositories for Agent Skills can discover the skill at the path
62+
above. This project does not claim to be listed on SkillsMP or any other marketplace, and it is not
63+
an official OpenAI plugin or official marketplace project.
64+
65+
## Plugin Readiness
66+
67+
Codex documentation describes Skills as the reusable workflow authoring format and Plugins as the
68+
installable distribution unit for reusable skills and apps. This repository now includes
69+
`.codex-plugin/plugin.json` metadata that points to `./skills/` so future Codex plugin tooling can
70+
identify the bundled skill.
71+
72+
Current supported installation is still the Codex-managed flow in [Install](#install). The plugin
73+
metadata is preparatory discovery/packaging metadata only; it does not install hooks, change
74+
provider config, start the proxy, or imply an official marketplace listing.
75+
4776
## Install
4877

4978
Paste this into Codex:
@@ -309,6 +338,31 @@ Codex App 发送 `POST /v1/responses` 时可能没有 `service_tier` 字段,
309338
由 Codex 读取自己的 provider 配置,proxy 只补缺失的 Fast 参数,并通过本地只读 dashboard 展示
310339
状态、最近请求和 benchmark 结果,方便确认 App 是否真的走到了 priority 通道。
311340

341+
### Agent Skill 和可发现性
342+
343+
这个仓库包含一个 Codex Agent Skill:
344+
345+
- Skill 名称:`codex-fast-proxy`
346+
- Skill 路径:`skills/codex-fast-proxy/SKILL.md`
347+
- 用途:让使用第三方 OpenAI-compatible API provider / 中转站的 Codex App 用户,也能启用、检查、
348+
benchmark、更新和卸载 Fast / Priority 路径。
349+
- 安全边界:proxy 只处理 `POST /v1/responses`,只在缺失 `service_tier` 时注入
350+
`service_tier="priority"`,不改 `model``reasoning``tools``input`,也不改 SSE 流。
351+
- Benchmark:运行 `python -m codex_fast_proxy benchmark`,或直接让 Codex 跑 A/B benchmark。
352+
dashboard 会只读展示最近一次已保存的脱敏 benchmark 摘要。
353+
354+
会索引公开 GitHub 仓库中 Agent Skills 的工具,可以通过上面的路径发现这个 skill。本项目不声称
355+
已经被 SkillsMP 或其它 marketplace 收录,也不声称是 OpenAI 官方 plugin 或官方 marketplace 项目。
356+
357+
### Plugin readiness
358+
359+
Codex 官方文档把 Skill 定义为可复用 workflow 的 authoring format,把 Plugin 定义为可安装的分发单元。
360+
当前仓库已经包含 `.codex-plugin/plugin.json` 元数据,并指向 `./skills/`,方便后续按 Codex plugin
361+
分发格式整理。
362+
363+
当前正式支持的安装方式仍然是下面的 Codex-managed 安装流程。这个 plugin metadata 只是为发现和后续
364+
打包做准备,不会安装 hook、不会改 provider config、不会启动 proxy,也不代表已经进入官方 marketplace。
365+
312366
### 快速安装
313367

314368
把这句话贴给 Codex:

pyproject.toml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,36 @@ build-backend = "setuptools.build_meta"
55
[project]
66
name = "codex-fast-proxy"
77
version = "0.1.0"
8-
description = "Local Codex App proxy that injects service_tier=priority for Responses API calls."
8+
description = "Codex App Fast/Priority proxy for third-party OpenAI-compatible Responses API providers."
99
readme = "README.md"
1010
requires-python = ">=3.11"
1111
dependencies = []
1212
license = { text = "MIT" }
13+
keywords = [
14+
"agent-skills",
15+
"codex",
16+
"openai-codex",
17+
"codex-skill",
18+
"skills",
19+
"ai-agents",
20+
"responses-api",
21+
"fast-mode",
22+
"service-tier",
23+
"openai-compatible-api",
24+
]
1325
classifiers = [
1426
"License :: OSI Approved :: MIT License",
1527
"Programming Language :: Python :: 3",
1628
"Programming Language :: Python :: 3 :: Only",
1729
"Operating System :: OS Independent",
1830
]
1931

32+
[project.urls]
33+
Homepage = "https://github.com/gaoguobin/codex-fast-proxy#readme"
34+
Repository = "https://github.com/gaoguobin/codex-fast-proxy"
35+
Issues = "https://github.com/gaoguobin/codex-fast-proxy/issues"
36+
Documentation = "https://github.com/gaoguobin/codex-fast-proxy#readme"
37+
2038
[project.scripts]
2139
codex-fast-proxy = "codex_fast_proxy.manager:main"
2240

skills/codex-fast-proxy/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: codex-fast-proxy
3-
description: Installs, enables, checks, benchmarks, changes upstream URL, stops, or uninstalls Codex App Fast proxy. Use when the user asks for Codex App Fast, priority service_tier, PackyAPI Fast, provider acceleration, Fast/Priority A/B benchmark, or says phrases like "启用 Codex Fast proxy", "让 Codex App 使用 Fast", "跑 Fast proxy benchmark", "验证供应商是否支持 Fast", "把 Codex Fast proxy 的上游切到", "查看 Fast proxy 状态", or "停止 Codex Fast proxy".
3+
description: Codex App Fast proxy for third-party OpenAI-compatible APIs. Enables, checks, benchmarks, changes upstream, stops, or uninstalls a local Responses API proxy that injects priority service_tier.
44
---
55

66
Use this skill when the user wants Codex to manage the local Fast proxy for Codex App.

0 commit comments

Comments
 (0)