Markup.ai MCP服务器
模型上下文协议(MCP)服务器,与Markup.ai API集成,为Claude和Cursor等人工智能助手提供高级文本分析和改进功能。
特性
- 文本重写:自动改善文本的清晰度、色调和风格指南合规性
- 内容分析:获得多个维度的详细质量分数
- 写作建议:收到文本改进的具体建议
- 风格指南支持:美联社、芝加哥风格手册、微软和Proofpoint
- 多种方言:美国英语、英国英语、澳大利亚英语和加拿大英语
- 音调灵活性:学术、商务、休闲、会话、正式、gen-z、非正式和技术
安装
先决条件
- Node.js 18.0.0或更高版本
- Markup AI API密钥
设置
- 克隆存储库:
git clone https://github.com/markupai/mcp.git
cd mcp- 安装依赖项:
npm install- 配置环境变量:
cp .env.example .env
# Edit .env and add your MARKUPAI_API_KEY- 构建项目:
npm run build配置
| 变量 | 必填 | 描述 | 默认值 |
|---|---|---|---|
MARKUPAI_API_KEY | 是 | 您的Markup.ai API密钥 | - |
MARKUPAI_BASE_URL | 否 | API基础URL | https://api.markup.ai |
DEBUG | 否 | 启用调试日志记录 | false |
MAX_TEXT_LENGTH | 否 | 最大文本长度(字符) | 100000 |
WORKFLOW_TIMEOUT | 否 | 工作流超时(ms) | 60000 |
POLL_INTERVAL | 否 | 状态检查间隔(ms) | 2000 |
MAX_RETRIES | 没有 | API重试尝试 | 3 |
使用AI IDE
此MCP服务器与支持模型上下文协议的任何IDE兼容,包括Claude Desktop和Cursor。
配置
所有MCP兼容IDE的配置都是相同的。只有 配置文件位置 不同之处:
| IDE | 配置文件位置 |
|---|---|
| 克劳德桌面 (macOS) | ~/Library/Application Support/Claude/claude_desktop_config.json |
| 克劳德桌面 (Windows) | %APPDATA%\Claude\claude_desktop_config.json |
| 光标 (macOS/Linux) | ~/.cursor/mcp.json |
| 光标 (Windows) | %USERPROFILE%\.cursor\mcp.json |
选项1:直接从GitHub运行(推荐)
将此配置添加到IDE的MCP配置文件中:
{
"mcpServers": {
"markupai": {
"command": "npx",
"args": [
"-y",
"github:markupai/mcp"
],
"env": {
"MARKUPAI_API_KEY": "your_api_key_here"
}
}
}
}选项2:从本地安装运行
对于本地开发,或者如果您更喜欢从本地安装运行:
{
"mcpServers": {
"markupai": {
"command": "node",
"args": ["/path/to/mcp/dist/index.js"],
"env": {
"MARKUPAI_API_KEY": "your_api_key_here"
}
}
}
}备注:更新配置后,重新启动IDE以使更改生效。
与光标一起使用
当将此MCP服务器与Cursor一起使用时,当AI想要使用Markup.AI工具时,您将看到一条“调用未定义”的消息,并带有“运行工具”按钮。这是 正常行为 -只需点击“运行工具”即可批准分析。此手动批准是Cursor用于MCP工具执行的安全功能。
可用工具
markupai_rewrite
自动重写和改进文本内容。
参数:
text(必填):需重写的文本dialect:语言方言(默认:“american_english”)tone:所需音调(默认:“正式”)style_guide:要遵循的样式指南(默认值:“microsoft”)
markupai_check
在不进行更改的情况下分析文本的质量问题。
参数:
text(必填):要分析的文本dialect:语言方言(默认:“american_english”)tone:要检查的目标音调(默认值:“正式”)style_guide:要检查的样式指南(默认值:“microsoft”)
markupai_suggestions
获取改进文本的详细编辑建议。
参数:
text(必填):获取建议的文本dialect:语言方言(默认:“american_english”)tone:建议的目标语气(默认:“正式”)style_guide:建议样式指南(默认:“microsoft”)
markupai_workflow_status
检查异步工作流的状态。
参数:
workflow_id(必填):要检查的工作流IDworkflow_type(必填):工作流类型(“重写”、“检查”或“建议”)
发展
以开发模式运行
npm run dev运行测试
# Test suggestions endpoint
node test-suggestions.js
# Test complete workflow
node test-suggestions-complete.js建筑
npm run build故障排除
常见问题
- 游标中的“调用未定义”消息:这是正常的游标行为,不是错误。当您看到带有“运行工具”按钮的此消息时,单击该按钮以执行Markup.ai分析。这是Cursor的安全功能,需要手动批准MCP工具的执行。
- 游标中出现“客户端已关闭”错误:尝试清除npx缓存:
npx clear-npx-cache并重新启动Cursor
- API关键问题:验证您的
MARKUPAI_API_KEY在环境变量中正确设置
- 权限错误:在Unix系统上,确保编译的JavaScript文件是可执行的(
chmod +x dist/index.js)
调试模式
通过设置启用调试日志记录 DEBUG=true 在您的环境中:
DEBUG=true npm run start建筑
服务器使用stdio传输实现模型上下文协议,并提供四个与Markup.ai API交互的主要工具。主要特征包括:
- 跨IDE兼容性:适用于Claude Desktop、Cursor和任何兼容MCP的IDE
- 重试逻辑:指数级回退,提高可靠性
- 超时处理:长时间运行操作的可配置超时
- 综合录井:故障排除的调试模式
- 类型安全:带有适当类型保护的完整TypeScript实现
- 优雅地关闭:终止时进行适当的清理
许可证
麻省理工学院
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 跑
npm run build确保一切顺利 - 提交拉取请求
支持
对于问题和疑问:
- 在GitHub上创建问题
- 检查 标记AI文档
- 联系Markup.ai支持
