Targetprocess MCP 服务器

模型上下文协议 (MCP) 是一种标准，它使 AI 助手能够通过统一的接口与外部工具和服务进行交互。 MCP 服务器通过公开 AI 助手可用于完成任务的工具和资源来提供这些功能。

此 MCP 服务器提供用于与 Targetprocess（一个项目管理和敏捷计划平台）交互的工具。 它使 AI 助手能够：

• 搜索和检索 Targetprocess 实体（用户故事、缺陷、任务、功能等）
• 创建和更新具有适当验证的实体
• 使用复杂的过滤器和包含项查询实体
• 检查和发现 Targetprocess 数据模型
• 安全地处理身份验证和 API 交互

主要特性

• 数据模型发现：探索和理解复杂的 Targetprocess 实现
• 强大的查询：使用复杂的过滤器和包含项来检索您需要的确切数据
• 实体管理：创建和更新具有适当验证的实体
• 关系探索：了解不同实体之间的关系
• 错误处理：强大的错误处理，具有重试和信息性消息
• 文档集成：内置访问 Targetprocess 文档

使用案例

此 MCP 服务器在公司环境中尤其有价值，在这些环境中，Targetprocess 可能会处理数百万条具有复杂模式和数据模型的记录。 常见用例包括：

• 数据模型发现：映射和理解复杂的 Targetprocess 实现
• 企业分析：提取和分析数百万条记录中的数据
• 跨系统集成：用作 Targetprocess 和其他系统之间的桥梁
• 自定义报告：构建标准 UI 中不可用的专用报告
• 批量操作：管理许多实体中的大规模更改
• 模式探索：发现复杂实现中的自定义字段和关系

有关详细示例和实施指南，请参阅 USECASES.md。

开始使用

以递归方式克隆存储库以包含文档搜索工具：

git clone --recursive https://github.com/aaronsb/apptio-target-process-mcp.git
cd apptio-target-process-mcp

开发资源

文档搜索

此存储库包含 Targetprocess 开发人员文档的文档抓取工具/搜索器，作为子模块。 您可以使用它来快速搜索 Targetprocess 的文档：

# 从项目根目录：
pushd resources/target-process-docs && npm install && ./refresh-docs.sh && popd  # 首次设置

# 要搜索文档（从任何目录）：
pushd resources/target-process-docs && ./search-docs.sh "您的搜索查询" && popd

# 示例搜索：
pushd resources/target-process-docs && ./search-docs.sh "entity states" && popd

搜索工具位于 resources/target-process-docs 中。 我们在这里使用 pushd/popd 命令，因为：

1. 该工具需要使用相对路径访问其数据库文件
2. pushd 保存您当前的目录位置
3. 临时更改为该工具的目录以运行该命令
4. popd 自动返回到您之前的位置 这种方法使您可以从任何目录运行搜索，同时确保该工具可以找到其数据库文件。

此工具提供了一种强大的方式来在本地搜索 Targetprocess 的开发人员文档。 搜索结果包括具有上下文的相关文档部分，从而更容易找到特定的 API 详细信息或实施指南。

CI/CD 管道

该项目使用 GitHub Actions 进行自动构建：

• 推送到 main 分支会触发新的容器构建
• 版本标签 (v*..) 创建版本化的发布
• 图像发布到 GitHub Container Registry

您可以使用已发布的图像：

docker run -i --rm \
  -e TP_DOMAIN=your-domain.tpondemand.com \
  -e TP_USERNAME=your-username \
  -e TP_PASSWORD=your-password \
  ghcr.io/aaronsb/apptio-target-process-mcp

环境变量

• TP_DOMAIN：您的 Targetprocess 域（例如，company.tpondemand.com）
• TP_USERNAME：您的 Targetprocess 用户名
• TP_PASSWORD：您的 Targetprocess 密码

使用 Docker 进行本地开发

对于本地开发和测试，请使用提供的脚本：

1. 构建本地镜像：

   注意：默认情况下，构建脚本使用 Docker 的静默模式来最大限度地减少日志输出。 这是为了减少与 Cline 等处理构建输出的工具交互时的 AI 令牌消耗。 在静默模式下，完整的构建日志将保存到 /tmp/apptio-target-process-mcp/docker-build.log。 使用 --verbose 标志可直接在终端中查看构建输出。

./scripts/build-local.sh         # 静默模式（默认），记录到文件
./scripts/build-local.sh --verbose  # 终端中的完整构建输出

2. 运行本地镜像：

./scripts/run-local.sh

3. 配置 Cline： 编辑 ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json：

{
  "mcpServers": {
    "targetprocess": {
      "command": "./scripts/run-local.sh",
      "disabled": false,
      "autoApprove": []
    }
  }
}

不使用 Docker 进行本地开发

先决条件

• Node.js 20 或更高版本
• npm

设置

1. 以递归方式克隆存储库：

git clone --recursive https://github.com/modelcontextprotocol/targetprocess-mcp.git
cd targetprocess-mcp

注意：需要 --recursive 标志才能同时克隆文档搜索工具子模块。

2. 安装依赖项：

npm install

3. 复制示例配置：

cp config/targetprocess.example.json config/targetprocess.json

4. 使用您的 Targetprocess 凭据编辑 config/targetprocess.json。

构建

npm run build

运行

node build/index.js

API 功能

有关详细示例和常见用例，请参阅 USECASES.md。

MCP 服务器提供以下工具用于与 Targetprocess 交互：

search_entities

搜索具有过滤和包含项的 Targetprocess 实体（UserStory、Bug、Task、Feature）。

{
  "type": "UserStory",          // 必需：要搜索的实体类型
  "where": "EntityState.Name eq 'Open'", // 可选：筛选表达式
  "take": 10,                   // 可选：要返回的项目数（默认值：100，最大值：1000）
  "include": ["Project", "Team"] // 可选：要包含的相关数据
}

get_entity

获取有关特定实体的详细信息。

{
  "type": "UserStory",          // 必需：实体类型
  "id": 123456,                 // 必需：实体 ID
  "include": ["Project", "Team"] // 可选：要包含的相关数据
}

create_entity

在 Targetprocess 中创建一个新实体。

{
  "type": "UserStory",          // 必需：要创建的实体类型
  "name": "Story Name",         // 必需：实体名称
  "description": "Details...",  // 可选：实体描述
  "project": {                  // 必需：要在其中创建的项目
    "id": 123
  },
  "team": {                     // 可选：要分配的团队
    "id": 456
  }
}

update_entity

更新现有实体。

{
  "type": "UserStory",          // 必需：实体类型
  "id": 123456,                 // 必需：实体 ID
  "fields": {                   // 必需：要更新的字段
    "name": "New Name",
    "description": "New description",
    "status": {
      "id": 789
    }
  }
}

inspect_object

通过 API 检查 Targetprocess 对象和属性。

{
  "action": "list_types",       // 必需：要执行的操作
  "entityType": "UserStory",    // 某些操作必需：要检查的实体类型
  "propertyName": "Description" // 某些操作必需：要检查的属性
}

性能注意事项

当处理可能包含数百万条记录的大型 Targetprocess 实例时：

1. 使用特定查询：始终使用尽可能具体的查询来限制结果集
2. 限制结果大小：使用 take 参数来限制返回的结果数
3. 仅包含必要数据：仅包含您实际需要的相关数据
4. 考虑分页：对于大型结果集，请在您的应用程序中实施分页
5. 批量操作：对于批量操作，请考虑批量处理请求以避免 API 过载

LLM 集成

此 MCP 服务器可以与支持模型上下文协议的各种 AI 助手一起使用：

• Cline - 基于 CLI 的 AI 助手
• Claude Desktop - Anthropic 的桌面应用程序
• Goose - 本地 AI 助手

有关配置和设置说明，请参阅 llms-install.md。

配置

可以通过环境变量或 JSON 配置文件来配置服务器。

配置文件格式

{
  "domain": "your-domain.tpondemand.com",
  "credentials": {
    "username": "your-username",
    "password": "your-password"
  }
}

许可证

MIT