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 模板覆蓋實現輸出自訂。