微信扫一扫article
README
🚀 目标流程 MCP 服务器文档
目标流程 MCP 服务器是为方便与 AI 助手集成而设，借助 Targetprocess 的 Model Context Protocol (MCP) 服务器，可通过命令行或桌面应用程序与强大的项目管理工具——目标流程进行交互，有效管理工作项、提升项目管理效率。
🚀 快速开始
目标流程（Targetprocess）是一款强大的项目管理工具，可对用户故事、任务、缺陷等各类工作项进行跟踪和管理。为实现与 AI 助手的便捷集成，我们推出了 Targetprocess 的 Model Context Protocol (MCP) 服务器，支持通过命令行或桌面应用程序与目标流程展开交互。
👥 目标用户
- 开发者：可借助脚本或自动化工具与目标流程进行交互。
- 项目管理员：能够使用 AI 工具辅助完成项目管理任务。
- 数据分析师：可从目标流程中提取并分析数据。
📦 安装指南
使用 Docker 安装（推荐）
-
克隆仓库：
git clone --recursive https://github.com/modelcontextprotocol/targetprocess-mcp.git cd targetprocess-mcp -
构建镜像并启动容器：
docker build -t targetprocess-mcp . docker run -it -p 3000:3000 targetprocess-mcp
本地安装
- 克隆仓库并解压。
- 安装依赖项：
npm install - 配置环境变量或创建配置文件。
- 运行服务器：
node build/index.js
⚙️ 配置选项
环境变量
TARGETPROCESS_DOMAIN=your-domain.tpondemand.com
TARGETPROCESS_USERNAME=your-username
TARGETPROCESS_PASSWORD=your-password
配置文件
创建 config/targetprocess.json 文件：
{
"domain": "your-domain.tpondemand.com",
"credentials": {
"username": "your-username",
"password": "your-password"
}
}
✨ 主要特性
搜索实体
可搜索目标流程中的实体（如用户故事、任务、缺陷等）。
{
"type": "UserStory",
"where": "EntityState.Name eq 'Open'",
"take": 10,
"include": ["Project", "Team"]
}
获取实体详情
能获取特定实体的详细信息。
{
"type": "UserStory",
"id": 123456,
"include": ["Project", "Team"]
}
创建实体
可在目标流程中创建新实体。
{
"type": "UserStory",
"name": "故事名称",
"description": "详细描述...",
"project": { "id": 123 },
"team": { "id": 456 }
}
更新实体
可更新目标流程中的现有实体。
{
"type": "UserStory",
"id": 123456,
"name": "更新后的名称",
"description": "更新后的描述..."
}
⚠️ 性能注意事项
- 限制结果数量：使用
take参数来控制返回的结果数量。 - 筛选条件优化：合理使用
where条件以提高查询效率。 - 仅包含必要数据：通过
include参数选择需要的关联数据，避免不必要的加载。
🔌 LLM 集成
支持与以下工具集成：
- Cline：命令行界面工具。
- Claude Desktop：桌面端 AI 工具。
- Goose：其他兼容的工具。
📚 详细文档
API 端点
搜索实体
POST /api/entities/search
获取实体详情
GET /api/entities/{id}
创建实体
POST /api/entities
更新实体
PUT /api/entities/{id}
📄 许可证
本项目遵循 MIT 许可证。请查阅 LICENSE 文件以获取详细信息。
通过以上文档，您可以轻松地将目标流程与 AI 工具集成，提升项目管理效率。