cortex-docs/cortex

解决的问题

Cortex 简化了维护 API 一致开发工具的流程。它消除了从 API 规范中分别使用独立、碎片化的工具链来生成客户端 SDK、交互式文档和 AI 就绪接口的需要。

工作原理

Cortex 使用单一项目配置文件（cortex.config.yml）来摄入各种 API 规范——包括 OpenAPI、AsyncAPI、GraphQL、gRPC（Protocol Buffers）和 OpenRPC——以及 Markdown 文件。从这些源中，它会自动生成：

• 类型化 SDK：支持 11 种不同语言的客户端库（包括 TypeScript、Python、Go 和 Rust）。
• 交互式文档：包含 API 参考和指南的静态 HTML 站点。
• MCP 服务器：Model Context Protocol 服务器，为 AI 代理提供类型化工具、嵌入式规范和项目上下文。

适用人群

专为需要同时向人类开发者（通过 SDK 和文档）和 AI 代理（通过 MCP 服务器）分发其 API 的开发者和 API 提供者设计，所有三者均从单一事实来源保持同步。

亮点

• 多协议支持：支持 REST、WebSocket、GraphQL、gRPC 和 JSON-RPC。
• 统一生成：通过一条命令生成 SDK、文档和 MCP 服务器。
• AI 就绪：自动创建 MCP 服务器，使 AI 代理能够访问 API 工具和文档。
• 广泛语言支持：支持多种 SDK 目标语言，从 C++ 和 C# 到 Ruby 和 PHP。
• 可自定义：通过 Eta 模板覆盖实现输出自定义。