UseKeen 文档 MCP 服务器

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 API 密钥：从 UseKeen 服务获取 UseKeen API 密钥
2. Node.js（用于 NPX 安装）或 Docker（用于 Docker 安装）
3. Claude Desktop 或 带有 MCP 扩展的 VS Code

安装

选项 1：NPX（推荐）

使用此 MCP 服务器最简单的方法是通过 NPX：

bash
npx usekeen-mcp

选项 2：Docker

您也可以使用 Docker 运行服务器：

bash
docker run -e USEKEEN_API_KEY=your_api_key_here mcp/usekeen

选项 3：本地开发

对于本地开发或手动安装：

bash

克隆仓库

git clone
cd usekeen-mcp

复制环境文件并添加您的 API 密钥

cp .env.example .env

编辑 .env 并添加您的 USEKEEN_API_KEY

安装依赖

npm install

构建并运行

npm run build
npm start

配置

与 Claude Desktop 一起使用

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

NPX

json
{
"mcpServers": {
"usekeen": {
"command": "npx",
"args": [
"-y",
"usekeen-mcp"
],
"env": {
"USEKEEN_API_KEY": "your_api_key_here"
}
}
}
}

Docker

json
{
"mcpServers": {
"usekeen": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"USEKEEN_API_KEY",
"mcp/usekeen"
],
"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 键。

NPX

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

Docker

json
{
"mcp": {
"inputs": [
{
"type": "promptString",
"id": "usekeen_api_key",
"description": "UseKeen API Key",
"password": true
}
],
"servers": {
"usekeen": {
"command": "docker",
"args": ["run", "-i", "--rm", "mcp/usekeen"],
"env": {
"USEKEEN_API_KEY": "${input:usekeen_api_key}"
}
}
}
}
}

手动设置

使用辅助脚本

我们提供了两个辅助脚本来简化服务器的运行：

1. 本地执行：
   bash

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

   chmod +x run-local.sh

   本地运行服务器

   ./run-local.sh

2. Docker 执行：
   bash

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

   chmod +x run-docker.sh

   在 Docker 中运行服务器

   ./run-docker.sh两段脚本都会检查包含 USEKEEN_API_KEY 的 .env 文件。您可以根据提供的 .env.example 创建此文件。

使用 npm 运行

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

bash

安装依赖

npm install

构建 TypeScript 代码

npm run build

运行服务器

USEKEEN_API_KEY=your_api_key npm start

使用 Docker 运行

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

bash

构建 Docker 镜像

docker build -t mcp/usekeen .

运行容器

docker run -e USEKEEN_API_KEY=your_api_key mcp/usekeen

环境变量

• USEKEEN_API_KEY: 必需。用于身份验证的 UseKeen API 密钥。

故障排除

如果遇到错误，请验证以下几点：

1. 您的 UseKeen API 密钥有效且在配置中正确设置
2. 您有可用的互联网连接以访问 UseKeen API
3. UseKeen 服务当前可用

构建

Docker 构建：

bash
docker build -t mcp/usekeen .

许可证

此 MCP 服务器基于 MIT 许可证发布。这意味着您可以在遵守 MIT 许可证条款和条件的前提下自由使用、修改和分发该软件。