UseKeen 文档 MCP 服务器 (Python)

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

工具

1. usekeen_package_doc_search
   • 搜索包和服务的文档以查找实现细节、示例和规范
   • 必需输入：
     • package_name (字符串)：要搜索文档的包或服务名称（例如 react、aws-s3、docker）
   • 可选输入：
     • query (字符串)：在包/服务文档中查找特定信息的搜索词（例如 file upload example、authentication methods）
   • 返回：包含相关匹配项、URL 和代码片段的文档搜索结果

设置

1. 从 UseKeen 服务获取一个 UseKeen API 密钥
2. 如下所示设置环境并使用您的 API 密钥

安装

从 PyPI 安装

bash
pip install usekeen-mcp

从源码安装

bash

克隆仓库

git clone https://github.com/yourusername/usekeen-python-mcp.git
cd usekeen-python-mcp

安装包

pip install -e .

与 Claude Desktop 一起使用

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

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 键。

json
{
"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. 本地执行：
   bash

   使脚本可执行（仅首次需要）

   chmod +x scripts/run_local.sh

   本地运行服务器

   ./scripts/run_local.sh

2. Docker 执行：
   bash

   使脚本可执行（仅首次需要）

   chmod +x scripts/run_docker.sh

   在 Docker 中运行服务器

   ./scripts/run_docker.sh

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

使用 Python 运行

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

bash

设置 API 密钥

export USEKEEN_API_KEY=your_api_key

运行服务器

python -m usekeen_mcp

使用 Docker 运行

构建并运行带有 API 密钥的 Docker 容器：

bash

构建 Docker 镜像

docker build -t usekeen-mcp .

运行容器

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 许可证的条款和条件。