article
README
🚀 Writeathon MCP 服务器
这是一个基于MCP协议的Writeathon API服务器,为Writeathon平台提供集成的MCP服务,助力开发者更便捷地与平台进行交互。
🚀 快速开始
本服务器基于Node.js和TypeScript开发,使用MCP协议(模型上下文协议)提供服务,完整支持Writeathon API的所有功能,并提供REST API接口和MCP服务接口。
✨ 主要特性
- 基于Node.js和TypeScript开发,保证代码的高效性和可维护性。
- 使用MCP协议(模型上下文协议)提供服务,实现与Writeathon平台的无缝对接。
- 完整支持Writeathon API的所有功能,满足多样化的开发需求。
- 提供REST API接口和MCP服务接口,方便不同场景下的使用。
📦 安装指南
# 确保使用Node.js 20
nvm use 20
# 安装依赖
npm install
📚 详细文档
配置
- 复制
.env.example文件为.env。 - 编辑
.env文件,填入你的Writeathon用户ID、集成Token(在写athon→设置→集成中获取)和MCP API密钥。
# API配置
API_BASE_URL=https://api.writeathon.cn
WRITEATHON_USER_ID=your_user_id_here
WRITEATHON_TOKEN=your_integration_token_here
# 服务器配置
PORT=3000
HOST=localhost
# MCP配置
MCP_API_KEY=your_mcp_api_key_here
运行
# 开发模式运行
npm run dev
# 或者构建后运行
npm run build
npm start
- 服务器将在
HOST:PORT上运行。 - MCP服务将在
HOST:PORT+1上运行。 - MCP SSE地址为
HOST:PORT+1/mcp/sse。
API接口
服务器提供以下REST API接口:
GET /api/me- 获取用户信息POST /api/cards- 创建卡片GET /api/cards/recent- 获取最近更新的卡片列表POST /api/cards/get- 获取卡片POST /api/writing-pick- 写作拾贝
MCP服务
服务器提供以下MCP服务:
me- 获取用户信息create_card- 创建卡片recent_cards- 获取最近更新的卡片列表get_card- 获取卡片writing_pick- 写作拾贝
📄 许可证
ISC
Scan to contact