使用Keen MCP服务器
用于UseKeen API的MCP服务器,使Claude和其他人工智能助手能够搜索文档。
工具
usekeen_package_doc_search
- 搜索包和服务的文档,以查找实现细节、示例和规范
- 所需输入:
- package_name (string):要搜索文档的包或服务的名称(例如“react”、“aws-s3”、“docker”)
- 可选输入:
- query (string):在包/服务文档中查找特定信息的搜索词(例如“文件上传示例”、“身份验证方法”)
- 返回:包含相关匹配项、URL和片段的文档搜索结果
先决条件
- 使用Keen API密钥:从UseKeen服务获取UseKeen API密钥
- Node.js (用于NPX安装)或 码头工人 (用于Docker安装)
- 克劳德桌面 或 带有MCP扩展的VS代码
安装
选项1:NPX(推荐)
使用此MCP服务器的最简单方法是通过NPX:
npx usekeen-mcp选项2:Docker
您还可以使用Docker运行服务器:
docker run -e USEKEEN_API_KEY=your_api_key_here mcp/usekeen方案3:地方发展
对于本地开发或手动安装:
# Clone the repository
git clone
cd usekeen-mcp
# Copy environment file and add your API key
cp .env.example .env
# Edit .env and add your USEKEEN_API_KEY
# Install dependencies
npm install
# Build and run
npm run build
npm start配置
使用Claude Desktop
将以下内容添加到您的 claude_desktop_config.json:
NPX
{
"mcpServers": {
"usekeen": {
"command": "npx",
"args": [
"-y",
"usekeen-mcp"
],
"env": {
"USEKEEN_API_KEY": "your_api_key_here"
}
}
}
}码头工人
{
"mcpServers": {
"usekeen": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"USEKEEN_API_KEY",
"mcp/usekeen"
],
"env": {
"USEKEEN_API_KEY": "your_api_key_here"
}
}
}
}使用VS代码
对于手动安装,请将以下JSON块添加到VS Code中的用户设置(JSON)文件中。您可以按 Ctrl + Shift + P 和打字 Preferences: Open Settings (JSON).
您可以选择将其添加到名为的文件中 .vscode/mcp.json 在您的工作空间中。这将允许您与他人共享配置。
请注意mcp中不需要密钥.vscode/mcp.json文件。
NPX
{
"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}"
}
}
}
}
}码头工人
{
"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}"
}
}
}
}
}手动设置
使用辅助脚本
我们提供了两个辅助脚本,使运行服务器更容易:
- 本地执行:
# Make the script executable (first time only)
chmod +x run-local.sh
# Run the server locally
./run-local.sh- Docker执行:
# Make the script executable (first time only)
chmod +x run-docker.sh
# Run the server in Docker
./run-docker.sh两个脚本都将检查 .env 包含您的 USEKEEN_API_KEY。您可以根据提供的创建此文件 .env.example.
使用npm运行
设置 USEKEEN_API_KEY 环境变量并运行服务器:
# Install dependencies
npm install
# Build the TypeScript code
npm run build
# Run the server
USEKEEN_API_KEY=your_api_key npm start使用Docker运行
使用API键构建并运行Docker容器:
# Build the Docker image
docker build -t mcp/usekeen .
# Run the container
docker run -e USEKEEN_API_KEY=your_api_key mcp/usekeen环境变量
USEKEEN_API_KEY:必填。用于身份验证的UseKeen API密钥。
故障排除
如果遇到错误,请验证:
- 您的UseKeen API密钥是有效的,并且在您的配置中设置正确
- 您有一个活跃的互联网连接来访问UseKeen API
- UseKeen服务目前可用
MCP结果形状错误
- 服务器始终返回符合MCP的工具结果,如下所示
result.content(内容块阵列)。如果返回自定义对象而不是content。此服务器规范化API响应,还设置isError: true对于失败,客户端会正确地呈现它们。如果集成新工具,请确保它们返回{ content: [{ type: "text", text: "..." }] }并且永远不要将结果包装在自定义键下,例如{ result: { results: [...] } }.
构建
Docker构建:
docker build -t mcp/usekeen .许可证
此MCP服务器根据MIT许可证获得许可。这意味着您可以根据MIT许可证的条款和条件自由使用、修改和分发软件。
