关于 aidocs
aidocs 通过无需密钥的 MCP 服务和命令行界面提供公开的 OpenAI 文档。它面向需要查找文档、指南、更新日志和 API 参考资料的用户,工具范围限定为八项核心功能。
主要功能
- 01搜索和获取 OpenAI 文档
- 02列出文档并获取文档大纲
- 03搜索和获取更新日志条目
- 04获取 API 参考资料
- 05列出 OpenAI 指南
适用场景
- 01查找 OpenAI 功能相关文档
- 02阅读文档页面或其大纲
- 03查看 OpenAI 更新日志
- 04查询 API 参考详情
MCP 相关
其 MCP 服务提供八项工具,用于搜索和获取 OpenAI 文档及更新日志、列出文档和指南、获取大纲以及访问 API 参考资料。无需凭据。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
8收录的工具列表 · 更新于 1 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| limit | number | 否 | 要返回的搜索结果数上限(默认值为 10)。 |
| query | string | 是 | 用于匹配 OpenAI 文档的搜索词。 |
详细介绍
aidocs
将 OpenAI 文档作为 MCP 工具,连接到公开的 OpenAI 文档 网站。aidocs 是对 OpenAI 文档 MCP 服务核心功能的全新实现,并采用了新名称:代码全新编写,不复制 品牌内容。它从设计上无需密钥——文档网站是公开的,因此无需也不会要求提供 API 密钥。
工具(核心子集,共 8 个)
search_openai_docs、fetch_openai_doc、list_openai_docs、
get_openai_doc_outline、search_openai_changelog、
fetch_openai_changelog、get_api_reference、list_openai_guides。
此子集不包含:模型列表和元数据工具、助手和 会话工具、音频和实时文档工具、指南以外的 Cookbook 浏览功能、社区工具,以及账单/用量文档工具。
设置
无需凭据。可以选择通过
OPENAI_DOCS_BASE_URL 覆盖文档基础 URL(默认为 https://platform.openai.com/docs)。
获取失败时会显示底层网络错误或上游错误。
CLI
npx @reneturcios/aidocs search_openai_docs '{"query":"function calling"}'
npx @reneturcios/aidocs mcp # stdio MCP server
每个工具名称都是一个子命令,接受一个 JSON 对象参数。
MCP 客户端配置
{
"mcpServers": {
"aidocs": {
"command": "npx",
"args": ["-y", "@reneturcios/aidocs", "mcp"]
}
}
}
Docker
docker run -i ghcr.io/cloudcorprecords/aidocs
开发
npm install
npm run build
npm test
许可证
MIT
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。