UseKeen 文档 MCP 服务器 (Python)

用于 UseKeen 包文档搜索 API 的 MCP 服务器，使 Claude 和其他 AI 助手能够搜索包和服务的文档。

工具

1. usekeen_package_doc_search

   • 搜索软件包和服务的文档以查找实施细节、示例和规范

   • 必需输入：

     • package_name （字符串）：要搜索文档的包或服务的名称（例如“react”、“aws-s3”、“docker”）

   • 可选输入：

     • query （字符串）：搜索词以在包/服务文档中查找特定信息（例如“文件上传示例”，“身份验证方法”）

   • 返回：包含相关匹配、URL 和片段的文档搜索结果

Related MCP server: RAG Documentation MCP Server

设置

1. 从 UseKeen 服务获取 UseKeen API 密钥

2. 使用您的 API 密钥设置环境，如下所示

安装

来自 PyPI

pip install usekeen-mcp

来自源

# Clone the repository
git clone https://github.com/yourusername/usekeen-python-mcp.git
cd usekeen-python-mcp

# Install the package
pip install -e .

与 Claude Desktop 一起使用

将以下内容添加到您的claude_desktop_config.json中：

{
  "mcpServers": {
    "usekeen": {
      "command": "usekeen-mcp",
      "env": {
        "USEKEEN_API_KEY": "your_api_key_here"
      }
    }
  }
}

与 VS Code 一起使用

如需手动安装，请将以下 JSON 块添加到 VS Code 中的“用户设置 (JSON)”文件中。您可以按下Ctrl + Shift + P并输入Preferences: Open Settings (JSON)来完成此操作。

或者，您可以将其添加到工作区中名为.vscode/mcp.json的文件中。这样您就可以与其他人共享该配置。

请注意.vscode/mcp.json文件中不需要mcp键。

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "usekeen_api_key",
        "description": "UseKeen API Key",
        "password": true
      }
    ],
    "servers": {
      "usekeen": {
        "command": "usekeen-mcp",
        "env": {
          "USEKEEN_API_KEY": "${input:usekeen_api_key}"
        }
      }
    }
  }
}

手动设置

使用帮助脚本

我们提供了两个帮助脚本，以便更轻松地运行服务器：

1. 本地执行：

   # Make the script executable (first time only)
   chmod +x scripts/run_local.sh
   
   # Run the server locally
   ./scripts/run_local.sh

2. Docker执行：

   # Make the script executable (first time only)
   chmod +x scripts/run_docker.sh
   
   # Run the server in Docker
   ./scripts/run_docker.sh

这两个脚本都会检查包含USEKEEN_API_KEY的.env文件。你可以根据提供的.env.example创建此文件。

使用 Python 运行

设置USEKEEN_API_KEY环境变量并运行服务器：

# Set the API key
export USEKEEN_API_KEY=your_api_key

# Run the server
python -m usekeen_mcp

使用 Docker 运行

使用 API 密钥构建并运行 Docker 容器：

# Build the Docker image
docker build -t usekeen-mcp .

# Run the container
docker run -e USEKEEN_API_KEY=your_api_key usekeen-mcp

环境变量

• USEKEEN_API_KEY ：必填。用于身份验证的 UseKeen API 密钥。

故障排除

如果遇到错误，请验证：

1. 您的 UseKeen API 密钥有效且已在您的配置中正确设置

2. 您拥有有效的互联网连接，可以访问 UseKeen API

3. UseKeen 服务目前可用

执照

此 MCP 服务器遵循 MIT 许可证。这意味着您可以自由使用、修改和分发该软件，但须遵守 MIT 许可证的条款和条件。