README
🚀 Gotask - mcp
Gotask - mcp 是一个专为 Taskfile/go - task 设计的模型上下文协议(MCP)服务器,它能让生成式 AI 支持的代码代理在合适的时机运行任务,提升开发效率。
🚀 快速开始
先决条件
此项目和 mcp CLI 工具依赖于依赖管理工具 uv。你可以通过例如 brew install uv 安装(对于 Homebrew 用户)。其他安装方式请参考此处。
你还需要安装 Taskfile,使用 brew install go - task 对于 Homebrew 用户来说是可行的。其他安装方式请参考此处。
快速入门指南(针对 Cursor IDE)
- 确保你已经安装了先决条件。
- 克隆此仓库。
- 确保你的工作项目中有合适的
Taskfile.yml文件(你可以参考此项目中的示例进行启发)。 - 在 Cursor 设置 > MCP 服务器中,使用以下命令启动一个服务器:
uv run --with mcp --directory /path/to/gotask - mcp mcp run /path/to/gotask - mcp/src/server.py
💡 使用建议:
建议将 .cursor/rules/tool - use - rule.mdc 中的上下文规则复制到你的工作项目中(或者编写类似的规则)。Cursor Agent 需要一些指令才能正确使用工具。
📚 详细文档
任务运行器(例如 Taskfile)是一种定义和运行简单或复杂工作的命令的方法,这些命令通常是定期需要执行的。这样的任务可以成为开发周期中的重要部分,例如自动修复和 QA 检查。因此,如果由生成式 AI 支持的代码代理能够在适当的时候运行这些任务,这将非常有用。实现这一目标的方式是通过一个 MCP 服务器提供运行此类任务的工具。
该服务器设计为在一个隔离环境中运行,并允许客户端(例如 Cursor IDE Agent)传递工作项目的上下文信息。具体提供了以下工具:
- 一个用于获取可用任务列表的工具
- 一个用于运行指定名称任务的工具
Cursor Agent 需要将工作目录路径作为输入传递给这些工具,以便工具可以读取项目 Taskfile.yml 文件。
⚠️ 重要提示:在编写本文时,MCP 资源与 Cursor IDE 的集成效果不理想——第一个工具应理想地实现为一个资源,而不是工具。
微信扫一扫