ARTICLE DETAIL

资讯详情

深耕网站建设、视觉设计与SEO优化的一线实战洞察。

openai-agents-python 仓库中的 openai-knowledge 技能:通过 Codex MCP 检索权威 OpenAI 文档的完整指南

openai-agents-python 仓库中的 openai-knowledge 技能:通过 Codex MCP 检索权威 OpenAI 文档的完整指南 openai-agents-python 仓库中的 openai-knowledge 技能通过 Codex MCP 检索权威 OpenAI 文档的完整指南【免费下载链接】openai-agents-pythonA lightweight, powerful framework for multi-agent workflows项目地址: https://gitcode.com/GitHub_Trending/op/openai-agents-python导读openai-knowledge是 openai-agents-python 仓库在.agents/skills/openai-knowledge/SKILL.md中定义的一个 Codex 技能Skill核心目标是为 AI 编码助手提供一条检索 OpenAI 官方文档的权威通道当一次集成或某个技术论断需要当前的外部证据时不再依赖模型记忆或猜测而是通过 OpenAI Developer Docs MCP 服务器搜索并抓取精确的文档原文markdown再以此为基础作答。读完本文你将掌握该技能的三步工作流、四个 MCP 工具的确切用法、两种配置方式CLI 与config.toml以及它在当前仓库中被其他技能协作调用的真实场景。技能概览一个面向事实求证的 Codex Skillopenai-knowledge的完整定义位于 .agents/skills/openai-knowledge/SKILL.md其 frontmatter 给出了技能的两个核心元数据--- name: openai-knowledge description: Retrieve authoritative OpenAI API and platform documentation when an integration or claim needs current external evidence. ---name技能的调用标识符其他技能通过$openai-knowledge语法引用它description声明技能的适用场景——当一次集成或某个论断需要当前的外部证据时用它拉取权威的 OpenAI API 与平台文档。技能的人机界面声明位于同目录下的 .agents/skills/openai-knowledge/agents/openai.yamlinterface: display_name: OpenAI Knowledge short_description: Pull authoritative OpenAI platform documentation default_prompt: Use $openai-knowledge to fetch the exact OpenAI docs needed for this API or platform question.从源码结构看这个 yaml 定义了两层信息面向用户的展示名与短描述以及一个default_prompt——它把获取解决 API/平台问题所需的精确 OpenAI 文档固化为默认提示词供上层 Agent 界面直接采用。这意味着该技能不仅能被人工提示词触发还能被其他技能在流程中按需调用。技能的核心工作流三步完成文档取证SKILL.md 将整个使用过程组织为三步工作流下面逐一展开。第 1 步检查 Docs MCP 服务器是否可用技能依赖 OpenAI Developer Docs 的 MCP 服务器暴露的一组工具这些工具在 Codex 中统一以mcp__openaiDeveloperDocs__*前缀命名。第一步是确认它们当前可用直接检查工具列表如果会话中已经能看到mcp__openaiDeveloperDocs__*系列工具直接使用即可不确定时运行命令确认执行codex mcp list查看输出中是否存在openaiDeveloperDocs服务器条目。这一步是证据链的前置校验只有确认 MCP 通道在线后续拉取的文档才是可信的、可引用的。第 2 步用 MCP 工具拉取精确文档技能规定了先搜索、后抓取的检索顺序并给出了四个工具的分工MCP 工具用途mcp__openaiDeveloperDocs__search_openai_docs先搜索 OpenAI 文档从结果中挑选最合适的 URLmcp__openaiDeveloperDocs__fetch_openai_doc抓取指定页面的精确 markdown 原文可选地携带anchor定位到小节锚点mcp__openaiDeveloperDocs__get_openapi_spec获取端点级 schema 与参数定义OpenAPI 规范mcp__openaiDeveloperDocs__list_api_endpoints枚举 API 端点清单需要特别强调的是 SKILL.md 中的红线约束Base your answer on the fetched text and quote or paraphrase it precisely. Do not invent flags, field names, defaults, or limits.即回答必须基于抓取到的文档文本可以精确引用或转述但绝不能自行编造标志位、字段名、默认值或限制。这正是该技能与凭记忆作答的本质区别——它把 OpenAI 文档当作运行时数据源而不是模型参数的隐性记忆。第 3 步MCP 未配置时引导用户完成设置如果mcp__openaiDeveloperDocs__*工具不可用技能要求只提供配置指引、不擅自修改配置并提示用户在配置完成后重启 Codex 会话使工具加载生效。两种配置方式如下。方式一CLI 命令codex mcp add openaiDeveloperDocs --url https://developers.openai.com/mcp方式二配置文件~/.codex/config.toml在配置文件中追加[mcp_servers.openaiDeveloperDocs] url https://developers.openai.com/mcp两种方式指向同一个 MCP 端点https://developers.openai.com/mcp。配置完成后需要重启 Codex 会话工具才会出现在mcp__openaiDeveloperDocs__*命名空间下随后即可回到第 1 步验证可用性。仓库内的真实协作场景其他技能如何调用它openai-knowledge并非孤立存在。在当前仓库中多个技能与参考资料把它作为OpenAI 平台行为的事实源显式调用这从侧面验证了它的定位与用法。.agents/skills/docs-sync/SKILL.md该技能负责审计或更新英文 SDK 文档。其工作流明确要求——当主题涉及 OpenAI 平台特性时先调用$openai-knowledge从 OpenAI Developer Docs MCP 服务器拉取当前细节而不是猜测同时规定当 SDK 源码与文档出现出入时以 SDK 源码为准。这体现了一个重要的协作原则openai-knowledge提供平台侧事实源码提供SDK 侧事实二者交叉校验。.agents/skills/runtime-behavior-probe/SKILL.md该技能负责对运行时行为做探针验证。它要求在进行 OpenAI API / 平台探针时尽早使用$openai-knowledge确认参数、字段名、限制等契约敏感细节并用运行时探针去验证或挑战文档行为而不是跳过文档环节如果 Docs MCP 不可用则回退到官方文档并在报告中声明使用了回退方案。.agents/references/local-mcp-server-lifecycle.md在涉及 Hosted MCP由 OpenAI Responses API 托管连接的远程 MCP 服务器这类平台侧协议面时明确要求使用$openai-knowledge获取该协议表面的事实。.agents/references/README.md该文件对仓库内部的知识分层做了约定——OpenAI API 或平台行为类知识不要存入 references 目录统一放到$openai-knowledge背后。这实际上把openai-knowledge定位成了仓库知识体系中平台事实的唯一权威出口避免在本地散落易过期的 API 细节。承载机制理解 Skill 背后的 MCP 基础设施openai-knowledge之所以能拉取精确文档依赖的是 MCPModel Context Protocol这一标准化协议。仓库的官方文档 docs/mcp.md 对 MCP 做了如下定位MCP 是一个开放协议标准化了应用向 LLM 提供上下文的方式。可以把 MCP 想象成 AI 应用的 USB-C 接口——USB-C 用标准化方式连接设备与外设MCP 用标准化方式连接 AI 模型与各类数据源、工具。在 openai-agents-python 中Agent 可以通过多种传输方式接入 MCP 服务器托管 MCP 工具HostedMCPTool、Streamable HTTP、HTTPSSE 与 stdio。openai-knowledge技能依赖的 OpenAI Developer Docs 服务器属于远程 HTTP 类服务器Codex 客户端通过codex mcp命令将其注册到本地会话。值得一提的是仓库对本地 MCP 服务器与托管 MCP 服务器做了明确的边界划分从源码看HostedMCPTool 的定义 位于src/agents/tool.py其 docstring 指出托管工具让 LLM 自动列出并调用远程 MCP 服务器上的工具无需回调到本地代码而本地 MCP 服务器则通过agents.mcp模块的MCPServerStdio、MCPServerSse、MCPServerStreamableHttp等类管理。openai-knowledge走的是前者——文档检索的完整往返发生在 OpenAI 基础设施与开发者文档之间Codex 本地进程不直接维护该连接因此也不需要在本仓库的 SDK 中配置任何本地 MCP 服务器。使用约束与最佳实践综合 SKILL.md 的规则与仓库内其他技能的协作方式使用openai-knowledge时应当遵循以下约束以抓取文本为准禁止臆造任何标志位、字段名、默认值、限制都必须来自抓取到的文档原文无法确认的内容不要写成事实。先搜索再抓取先用search_openai_docs定位最合适的页面再用fetch_openai_doc抓取原文需要端点级 schema 时再使用get_openapi_spec与list_api_endpoints。配置变更需用户授权当 MCP 未配置时只提供 CLI 或config.toml的配置指引不要擅自修改用户配置配置后需重启 Codex 会话使工具加载。与源码交叉验证如 .agents/skills/docs-sync/SKILL.md 所示当 OpenAI 平台文档与 SDK 源码出现出入时以当前仓库的 SDK 源码为准同时保留平台文档作为外部证据。把平台事实集中托管在该技能背后按 .agents/references/README.md 的知识分层约定不要将易过期的 OpenAI API / 平台行为细节散落存入仓库本地参考资料统一通过$openai-knowledge获取。小结openai-knowledge是一个典型小而精的 Codex 技能它不包含任何业务逻辑只定义了一条纪律严明的文档取证流程——检查 MCP 可用性 → 搜索并抓取权威文档 → 未配置时引导设置。它把OpenAI 平台事实从模型记忆与本地散落笔记中剥离出来统一托管到 OpenAI Developer Docs MCP 服务器之后并与 docs-sync、runtime-behavior-probe 等技能形成协作闭环为 openai-agents-python 仓库的文档维护、运行时验证与协议面开发提供了可靠的事实底座。【免费下载链接】openai-agents-pythonA lightweight, powerful framework for multi-agent workflows项目地址: https://gitcode.com/GitHub_Trending/op/openai-agents-python创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表