Cortex Docs icon

Cortex Docs

Cortex Docs 是开源工作流,可将 API 规范和 Markdown 转换为交互式文档、类型安全 SDK 与 MCP 服务器,帮助开发者和 AI 代理探索 API,并基于结构化上下文生成集成代码。

Cortex Docs

通过一个工作流生成 API 文档、SDK 和 MCP 服务器

Cortex Docs 是一个开源 API 工具工作流,可将 API 规范和 Markdown 转换为面向开发者的三类输出:交互式文档、类型安全 SDK 和 MCP 服务器。其配置模型将多个 API 表面整合到一个项目中,并在生成前验证契约。

该产品面向既需要用于探索 API 的人类界面,也需要用于 AI 辅助集成的代理界面的团队。生成的文档可以自行托管,而模板和生成的代码可以根据需要进行调整,并通过用户选择的基础设施发布。

核心能力

统一的 API 源工作流

在配置的项目中组合 API 定义和 Markdown,并在生成前验证契约。

交互式 API 文档

在文档站点中生成可搜索的指南、交互式参考、可直接复制的示例和实时请求构建器。

多语言 SDK 生成

为 TypeScript、Python、Go、Java、Kotlin、Ruby、PHP、C#、Rust、C++ 和 C 生成类型化客户端;网站中的示例和功能说明还涵盖身份验证、超时、流式传输、重试和软件包元数据。

面向代理的 MCP 服务器

将 API 操作映射为类型化 MCP 工具,并将规范、SDK 指南和项目文档与服务器一同打包。

开放且可部署的输出

使用开放模板和精简覆盖来调整生成的代码,将软件包发布到你自己的注册表,并在任何支持 Node 的环境中运行文档。

实际使用场景

  • 以代码形式维护文档的 API 团队

    在一个配置的项目中维护 API 定义和 Markdown,验证契约,并随着 API 的变化重新生成文档界面。

  • 开发者入门与集成

    为应用开发者提供可搜索的参考资料、可运行的请求探索、可直接复制的示例和用于 API 集成的类型化客户端。

  • 多语言客户端分发

    按照各语言生态的惯例提供客户端,使用为 TypeScript、Python、Go、Java、Kotlin、Ruby、PHP、C#、Rust、C++ 和 C 等语言生成的软件包。

  • 代理辅助的 API 集成

    将 API 操作作为类型化 MCP 工具公开,并提供规范和 SDK 指南,使 AI 代理能够发现接口并生成更有依据的集成代码。

  • 希望掌控生成输出的团队

    覆盖模板,将生成的软件包发布到内部或公共注册表,并将文档托管在支持 Node 的基础设施上。

Pros and Cons

Pros

  • 开源并采用 MIT 许可证,模板和生成的输出均可自定义。
  • 在一个配置的工作流中提供文档、SDK 和 MCP 生成功能。
  • 支持多种列出的 SDK 语言,包括 TypeScript、Python、Go、Java、Kotlin、Ruby、PHP、C#、Rust、C++ 和 C。
  • 包含面向代理的上下文,例如类型化 MCP 工具、嵌入式 API 规范、SDK 指南和项目文档。
  • 支持自行托管文档,并将生成的软件包发布到用户控制的注册表。

Cons

  • 网站未说明定价、托管方案、设置要求或运营限制;列出的定价 URL 返回 404。
  • 现有证据未明确说明完整的输入格式、部署配置或协作功能范围,除已记录的工作流和输出选项之外。

FAQ

Cortex Docs 能生成什么?

Cortex Docs 将 API 规范和 Markdown 作为项目源,然后通过配置的工作流生成交互式文档、类型安全 SDK 和 MCP 服务器。

Cortex Docs 可以使用哪些 API 源?

该网站展示了一个使用 OpenAPI 和 GraphQL 源的 cortex.config.yml 工作流。网站还说明,REST、实时、GraphQL、gRPC 和 JSON-RPC 源可以在同一个项目中组合使用,但具体实现所支持的源格式和设置要求仍应予以确认。

生成的输出可以自行托管或自定义吗?

生成的文档可以自行托管,生成的输出可以部署在任何支持 Node 的环境中。该项目还支持导出和覆盖模板,包括将生成的软件包发布到你自己的注册表。

Cortex Docs 如何支持 AI 代理?

生成的 MCP 服务器提供从 API 操作映射而来的类型化工具,并包含嵌入式规范、SDK 指南和项目文档,旨在为 AI 代理在集成过程中提供更多上下文。

Quick Facts

类别
开发者工具
主要用户
开发者和 AI 代理
输入
API 规范和 Markdown
输出
交互式文档、类型安全 SDK 和 MCP 服务器
许可证
MIT
源域名
cortexdocs.dev
Cortex Docs - AI Tool, Features, Use Cases & Alternatives | UStack