开发助手
用于开发辅助的MCP服务器,集成Git和Discord功能。
这个仓库包含一个小型的TypeScript项目,该项目使用MCP SDK构建,为常见的开发者工作流程(提交/推送、通知和完整工作流程)提供了实用工具。
快速入门
先决条件
- Node.js(建议使用长期支持版本,例如18+)
- npm(随Node一起提供)
安装依赖项
npm install构建
npm run build跑
npm start
# or for the development flow
npm run dev项目布局
src/— TypeScript 源文件
- index.ts — 入口点 - tools/ — 辅助工作流(提交并推送、发送通知、完整工作流)
build/— 编译输出(提交到仓库以进行分发)package.json— 脚本和元数据
编译后的输出位于 build/index.js 以及以下相关的文件 build/tools/。
环境变量
这个项目可能会从某个地方读取秘密或配置信息 .env 文件。创建一个 .env 在项目根目录中(不要将其提交)。
示例 .env 条目(占位符):
# DISCORD_TOKEN=your-discord-bot-token
# MCP_SDK_API_KEY=your-mcp-sdk-key
# NODE_ENV=development切勿在代码中硬编码秘密信息。在生产环境中,请使用环境变量或密钥管理工具。
脚本
npm run build— 将TypeScript编译为build/npm start— 运行构建好的应用(node ./build/index.js)npm run dev— 快捷键用于构建然后运行npm test— 目前为占位符
故障排除
- 如果
npm run build如果失败,请确保已安装TypeScript(npm install并且 Node 版本是兼容的。 - 如果运行时错误是由于缺少环境变量引起的,请添加所需的键到
.env或者您的环境。
贡献
欢迎提出小修补和改进。请在提交拉取请求(PR)时附上清晰的描述。确保提交内容中不包含敏感信息。
许可证
根据ISC授权(见 package.json)。
