Public Apis MCP

🚀 公共API MCP

這是一個帶有語義搜索功能的免費公共API目錄。該目錄包含了來自 public-apis GitHub倉庫的大量API列表。感謝所有的維護者、貢獻者和API創建者！💯

✨ 主要特性

• search_public_apis：基於嵌入向量的API名稱和描述搜索功能。
• get_public_api_details：通過 id 檢索API的完整詳細信息。
• 資源：public-apis://apis，public-apis://api/{id}

📦 安裝指南 (uv)

使用uv將其添加到MCP客戶端（例如Claude Desktop）。

Claude Desktop

macOS系統：~/Library/Application Support/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "public-apis": {
      "command": "uvx",
      "args": ["public-apis-mcp"]
    }
  }
}

🚀 快速開始

• 構建嵌入向量索引（可選；首次搜索時會自動構建）：

uvx public-apis-mcp build-index

• 通過標準輸入輸出運行MCP服務器：

uvx public-apis-mcp run

📚 詳細文檔

工具參考

search_public_apis

• 用途：對目錄進行語義搜索。
• 參數：query（字符串類型），limit（整數類型，默認值為5）。
• 返回值：{ id, name, score, snippet } 列表。

示例調用負載：

{ "name": "search_public_apis", "arguments": { "query": "weather", "limit": 5 } }

get_public_api_details

• 用途：通過 id 獲取完整詳細信息。
• 參數：id（字符串類型）。
• 返回值：ApiItem。

示例調用負載：

{ "name": "get_public_api_details", "arguments": { "id": "a6b3a6b3-a6b3-a6b3-a6b3-a6b3a6b3a6b3" } }

開發

前提條件

• Python 3.10 及以上版本。
• uv (https://docs.astral.sh/uv/)

安裝設置

uv sync --dev

運行測試

FREE_APIS_MCP_TEST_MODE=1 uv run pytest -q

代碼檢查和格式化

uv run ruff check --fix
uv run ruff format

類型檢查

uv run mypy src/

MCP客戶端開發配置

{
  "mcpServers": {
    "public-apis-dev": {
      "command": "uv",
      "args": [
        "--directory",
        "<abs_path>/public-apis-mcp",
        "run",
        "public-apis-mcp"
      ]
    }
  }
}

構建和測試

uv build
uv run --with dist/*.whl public-apis-mcp --help

數據與索引

• 數據：src/public_apis_mcp/datastore/free_apis.json
• 嵌入向量索引：src/public_apis_mcp/datastore/index.npz（自動構建）

使用MCP Inspector進行測試

若要探索和/或開發此服務器，請使用MCP Inspector npm實用工具：

# 安裝MCP Inspector
npm install -g @modelcontextprotocol/inspector

# 使用檢查器運行本地開發服務器
npx @modelcontextprotocol/inspector uv run public-apis-mcp

# 使用檢查器運行PyPI生產服務器
npx @modelcontextprotocol/inspector uvx public-apis-mcp

📄 許可證

本項目採用MIT許可證，詳情請參閱 LICENSE 文件。

🤝 貢獻

歡迎貢獻代碼！請隨時提交拉取請求。