使用说明
MonkeyType MCP服务器
这是一个模型上下文协议(MCP)服务器,提供对所有端点的访问 猴子类型API服务器公开MCP工具,该工具允许大型语言模型(LLM)与MonkeyType API交互。
特性
- 将所有MonkeyType API端点公开为MCP工具
- 与支持模型上下文协议的任何LLM兼容
- 每个工具调用简单的基于API密钥的身份验证
- 全面的错误处理
- 速率限制意识(尊重MonkeyType的速率限制)
安装
使用npx(推荐)
运行服务器最简单的方法是使用npx:
npx monkeytype-mcp
这将直接下载并运行服务器的最新版本。
全球安装
您还可以全局安装该软件包:
npm install -g monkeytype-mcp
monkeytype-mcp
手动安装
如果您更喜欢克隆存储库:
git clone https://github.com/CodeDreamer06/MonkeytypeMCP.git
cd MonkeytypeMCP
npm install
npm start
可用工具
服务器将以下MonkeyType API端点公开为MCP工具:
用户工具
check_username-检查用户名是否可用get_personal_bests-获取用户的个人最佳成绩get_tags-获取用户标签get_stats-获取用户的统计数据get_profile-获取用户的个人资料send_forgot_password_email-发送忘记密码的电子邮件get_current_test_activity-获取当前测试活动get_streak-获得用户连胜
测试结果工具
get_results-获取多达1000个测试结果get_result_by_id-按ID获取结果get_last_result-获取最后结果
公共工具
get_speed_histogram-获取速度直方图get_typing_stats-获取打字统计信息
排行榜工具
get_leaderboard-获取排行榜get_leaderboard_rank-获取排行榜排名get_daily_leaderboard-获取每日排行榜get_weekly_xp_leaderboard-获取每周XP排行榜
PSA工具
get_psas-获取PSA
报价工具
is_submission_enabled-检查是否启用报价提交
服务器配置工具
get_configuration-获取服务器配置
如何获取MonkeyType API密钥(ApeKey)
要获得您自己的MonkeyType API密钥(ApeKey),请执行以下步骤:
- 登录到您的 Monkey类型 账户
- 点击右上角的个人资料图标
- 从下拉菜单中选择“帐户”
- 导航到“猿键”选项卡
- 单击“生成新的”以创建新的API密钥
- 为您的密钥命名(例如,“MCP服务器”)
- 根据您需要访问的端点选择适当的范围
- 点击“生成”
- 复制生成的密钥
重要:确保API密钥的安全,切勿公开共享。
使用带LLM的MCP服务器
要将此服务器与LLM一起使用,您需要将LLM配置为将此服务器用于MCP工具调用。您必须通过设置 MONKEYTYPE_API_KEY MCP服务器配置中的环境变量。
环境变量
MONKEYTYPE_API_KEY:(必需)MonkeyType API密钥。您可以从monkeytype.com上的帐户设置中获取此信息。MONKEYTYPE_USERNAME:(可选)您的MonkeyType用户名或UID。这可以由某些工具使用(如get_profile)默认情况下或使用特定关键字时。
示例工具调用
{
"name": "get_configuration",
"arguments": {}
}
与LLM平台集成
要将此服务器与OpenAI、Anthropic或其他LLM平台集成:
- 使用上述安装方法之一启动MCP服务器
- 将LLM平台配置为将此服务器用作MCP工具提供程序
- 将服务器的stdio作为通信通道传递
IDE集成
MCP配置
要将MonkeyType MCP添加到IDE中,请将其添加到IDE的MCP配置文件中:
{
"mcpServers": {
"monkeytype": {
"command": "sh",
"args": ["-c", "cd $(mktemp -d) && npm install monkeytype-mcp && npx monkeytype-mcp"],
"env": {
"MONKEYTYPE_API_KEY": "YOUR_APE_KEY_HERE"
}
}
}
}
配置文件位置:
- 光标:
~/.cursor/mcp.json - 风浪:
~/.codeium/windsurf/mcp_config.json - 克莱恩:
~/.cline/mcp_config.json - 克劳德:
~/.claude/mcp_config.json
VS代码集成
要在VS代码中使用此MCP服务器:
- 打开VS代码设置
- 搜索“MCP服务器”
- 添加具有以下配置的新MCP服务器:
- 产品名称:MonkeyType MCP
- 命令:
npx monkeytype-mcp - 类型:标准输入/输出(stdio)
可用工具
服务器将以下MonkeyType API端点公开为MCP工具:
用户工具
check_username-检查用户名是否可用get_personal_bests-获取用户的个人最佳成绩get_tags-获取用户标签get_stats-获取用户的统计数据get_profile-获取用户的个人资料send_forgot_password_email-发送忘记密码的电子邮件get_current_test_activity-获取当前测试活动get_streak-获得用户连胜
get_profile
获取用户的公开个人资料。
参数:
uidOrName(string,可选):要获取其配置文件的用户的UID或用户名。- 如果您提供了特定的用户名或UID,则将获取该用户的个人资料。
- 你可以使用“我”、“自我”、“当前”或“我的”等关键词。如果使用其中一个关键字,该工具将使用
MONKEYTYPE_USERNAME环境变量(如果设置)。 - 如果完全省略此参数,该工具还将尝试使用
MONKEYTYPE_USERNAME环境变量(如果设置)。 - 如果
uidOrName省略参数(或使用关键字)MONKEYTYPE_USERNAME未设置环境变量,将发生错误。
测试结果工具
get_results-获取多达1000个测试结果get_result_by_id-按ID获取结果get_last_result-获取最后结果
公共工具
get_speed_histogram-获取速度直方图get_typing_stats-获取打字统计信息
排行榜工具
get_leaderboard-获取排行榜get_leaderboard_rank-获取排行榜排名get_daily_leaderboard-获取每日排行榜get_weekly_xp_leaderboard-获取每周XP排行榜
PSA工具
get_psas-获取PSA
报价工具
is_submission_enabled-检查是否启用报价提交
服务器配置工具
get_configuration-获取服务器配置
出版
如果您正在对此服务器进行更改并希望发布自己的版本:
npm login
npm publish
GitHub存储库
该项目托管在GitHub上 https://github.com/CodeDreamer06/MonkeytypeMCP.
许可证
此项目根据MIT许可证获得许可-有关详细信息,请参阅许可证文件。
致谢
- Monkey类型 用于提供API
- 模型上下文协议(MCP) 对于服务器架构
免责声明
该项目与MonkeyType没有正式关联。使用风险自负,并确保您遵守MonkeyType的服务条款和API费率限制。
