Api.market

🚀 API-MCP 服務器開發指南

本指南詳細介紹了 API-MCP 服務器的安裝、配置、使用示例、開發流程等內容，幫助開發者快速上手並進行二次開發。

🚀 快速開始

安裝依賴

克隆倉庫並安裝所需包，然後啟動開發環境：

git clone https://github.com/Noveum/api-market-mcp-server.git
cd api-market-mcp-server
npm install
npm run dev

配置說明

必要配置項

可選配置項

💻 使用示例

基礎用法

本服務器提供了多種實用功能，以下是一些使用示例：

• 示例 1：使用代理查找任意兩點之間的路線

• 示例 2：使用代理查找任何主題的新聞，然後深入研究相關文章

• 示例 3：使用代理查找可用域名

📚 詳細文檔

添加新 API 到 MCP 服務器

utils 文件夾包含管理 API 配置、解析 OpenAPI 規範和註冊新 API 的輔助腳本。具體步驟如下：

1. 獲取 OpenAPI 規範：找到要集成的 API 的 OpenAPI JSON 文件。在項目根目錄中創建一個名為 json_files 的文件夾，並將獲取到的 OpenAPI JSON 文件放入其中。
2. 修改 OpenAPI 規範：使用 modify_api.py 腳本更新規範中的路徑，使其包含文件名：

python utils/modify_api.py

3. 更新 API 概要：在修改路徑後，更新 API 概要。可以選擇以下兩種方式之一：
   • 自動縮短概要（使用 LLM）：

python utils/LLM_summary_shortener.py 

- **手動更新概要**：

python utils/manual_summary_shortener.py 

4. 構建與測試：重建項目以應用更改：

npm run build

然後使用以下命令測試新 API 集成：

npm run inspect

5. 提交代碼變更：如果希望將新 API 貢獻到倉庫中，需要叉叉 repo，創建功能分支，提交更改並生成拉取請求（PR）。
6. 發佈 MCP 服務器（可選）：如果要發佈更改，需要更新 package.json 文件（例如：更新版本號、名稱等），然後發佈包：

npm publish --access public

命令行參數

啟動命令

npm run start

配置文件路徑

通過在 package.json 中添加以下配置啟動 MCP 服務器：

"scripts": {
  "start": "mcp-server --apiBaseUrl https://your_api_base_url --openapiSpec ./specs"
}

調試信息

打印日誌

可以通過控制檯查看即時日誌：

npm run start

🤝 貢獻指南

• 問題反饋：提交 issue 到 Issues 頁面
• 代碼貢獻：提交拉取請求到 GitHub 倉庫

⚠️ 重要提示

⚠️ 重要提示

所有代碼示例和命令行語句均為 UTF-8 編碼，請確保在支持 UTF-8 的環境中運行。