Api Market MCP Server

🚀 API-MCP 服務器

API-MCP 服務器是一個強大的工具，它允許你集成和管理各種 API。通過簡單的安裝和配置步驟，你可以快速啟動並運行該服務器，還能根據需求進行開發和擴展。

🚀 快速開始

要安裝並運行 API-MCP 服務器，請按照以下步驟操作：

使用 npm 安裝

npm install -g @magicapi/mcp-server

啟動服務器

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

示例命令

示例 1：使用默認配置運行

mcp-server

示例 2：指定 API 基礎 URL 和密鑰

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

📦 安裝指南

要安裝 API-MCP 服務器，可使用 npm 進行全局安裝：

npm install -g @magicapi/mcp-server

安裝完成後，可使用以下命令啟動服務器：

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

💻 使用示例

基礎用法

以下是使用默認配置運行服務器的示例：

mcp-server

高級用法

指定 API 基礎 URL 和密鑰來運行服務器：

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

📚 詳細文檔

開發

添加新 API 到 MCP 服務器

步驟 1：定位 OpenAPI 規範

找到你想要集成的 API 的 OpenAPI JSON 文件。然後，在項目根目錄下創建一個名為 json_files 的文件夾，並將你的 OpenAPI JSON 文件添加到該文件夾中。

步驟 2：修改 OpenAPI 規範

在獲取到 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：提交你的更改

如果你希望將這些更改貢獻到倉庫：

• 叉出倉庫。
• 創建一個功能分支。
• 提交你的更改。
• 提交一個拉取請求（PR）。

步驟 6：發佈 MCP 服務器（可選）

如果你希望發佈你的更改：

• 更新 package.json 文件（例如，更新版本、名稱等）。
• 發佈包：

  npm publish --access public
  

開發工具

構建

• npm run build - 構建 TypeScript 源代碼。
• npm run clean - 刪除構建 artifacts。
• npm run typecheck - 運行 TypeScript 類型檢查。

開發模式

• npm run dev - 監視源文件並在發生更改時重新構建。
• npm run inspect-watch - 運行帶自動重載的 inspector。

代碼質量

• npm run lint - 運行 ESLint。
• npm run typecheck - 驗證 TypeScript 類型。

設置環境變量：

通過運行以下命令配置你的環境：

export OPENAPI_SPEC_PATH=modified_files.txt # 可選
export API_BASE_URL=https://api.magicapi.dev/api/v1/ # 可選
export NODE_OPTIONS=--loader ts-node/esm # 可選

貢獻指南

提交代碼

在提交代碼之前，請確保運行以下命令：

npm run lint
npm test

然後，提交你的更改並創建一個拉取請求。

調試或本地運行

安裝依賴項

npm install

啟動開發服務器

npm run dev

訪問文檔

訪問 文檔 查看更多詳細信息。

通過以上步驟，你可以輕鬆地安裝、配置和使用 API-MCP 服務器，並根據需要進行擴展和自定義。