Public Apis Mcp

公共 API MCP

提供免费公共 API 目录的语义搜索。

该目录包含来自 public-apis GitHub 仓库的大量 API 列表。
感谢所有维护者、贡献者和 API 创建者！💯

🎯 功能

• search_public_apis：基于嵌入向量搜索 API 名称和描述
• get_public_api_details：通过 id 获取完整详情
• 资源：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

• 通过 STDIO 运行 MCP 服务：

uvx public-apis-mcp run

📋 工具参考

search_public_apis

• 用途：对目录进行语义搜索
• 参数：query（str）、limit（int，默认值为 5）
• 返回：{ id, name, score, snippet } 列表

调用载荷示例：

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

get_public_api_details

• 用途：通过 id 获取完整详情
• 参数：id（str）
• 返回：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 工具：

# Install MCP Inspector
npm install -g @modelcontextprotocol/inspector

# Run local development server with the inspector
npx @modelcontextprotocol/inspector uv run public-apis-mcp

# Run PyPI production server with the inspector
npx @modelcontextprotocol/inspector uvx public-apis-mcp

📝 许可证

MIT 许可证——详情请参阅 LICENSE 文件。

🤝 贡献

欢迎贡献！请随时提交 Pull Request。