Targetprocess MCP 服务器使用说明

项目简介

本项目是 Targetprocess MCP 服务器，它实现了 Model Context Protocol (MCP)，旨在为 AI 助手提供一个标准化的接口，使其能够安全、可扩展地访问和操作 Targetprocess 项目管理平台的数据和功能。通过此 MCP 服务器，AI 助手可以与 Targetprocess 进行集成，执行诸如查询、创建、更新项目实体以及探索数据模型等操作。

主要功能点

数据模型发现: 帮助 AI 理解 Targetprocess 复杂的数据模型和自定义字段。
强大的查询能力: 支持使用复杂的过滤器和包含项检索所需的数据。
实体管理: 允许 AI 助手创建和更新 Targetprocess 中的各种实体，例如用户故事、缺陷、任务等。
关系探索: 帮助理解不同实体之间的关系。
文档集成: 内置访问 Targetprocess 开发者文档的功能，方便查询 API 细节。

安装步骤

克隆仓库: 使用以下命令递归克隆仓库，包含文档搜索工具子模块：

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

安装依赖: 进入项目目录后，运行以下命令安装 Node.js 依赖：
```
npm install
```
配置服务器:
- 通过环境变量配置 (推荐): 设置以下环境变量以连接到您的 Targetprocess 实例：
  - 'TP_DOMAIN': 您的 Targetprocess 域名 (例如：'your-domain.tpondemand.com')
  - 'TP_USERNAME': 您的 Targetprocess 用户名
  - 'TP_PASSWORD': 您的 Targetprocess 密码
- 通过配置文件配置:
  - 复制示例配置文件并重命名为 'config/targetprocess.json':
```
cp config/targetprocess.example.json config/targetprocess.json
```
  - 编辑 'config/targetprocess.json' 文件，填入您的 Targetprocess 域名、用户名和密码。
构建项目: 运行以下命令构建项目：
```
npm run build
```

服务器配置 (MCP 客户端)

对于 MCP 客户端，您需要配置服务器的启动命令。以下是针对此 Targetprocess MCP 服务器的配置示例 (JSON 格式):

{
  "serverName": "targetprocess",
  "command": "node",
  "args": [
    "build/index.js"
  ],
  "environmentVariables": {
    // 如果您选择环境变量配置，请在此处或系统环境中设置以下变量
    // "TP_DOMAIN": "your-domain.tpondemand.com", // 您的 Targetprocess 域名
    // "TP_USERNAME": "your-username",          // 您的 Targetprocess 用户名
    // "TP_PASSWORD": "your-password"          // 您的 Targetprocess 密码
  }
  // 如果您选择配置文件配置，则无需配置 environmentVariables，
  // 但请确保 'config/targetprocess.json' 文件位于服务器的工作目录下。
}

配置说明:

'"serverName"': 为您的 MCP 服务器指定一个名称，例如 "targetprocess"，在客户端中用于标识该服务器。
'"command"': 启动服务器的命令，这里使用 'node' 运行 Node.js 程序。
'"args"': 命令参数，指定要执行的 Javascript 文件 'build/index.js'，这是编译后的服务器入口文件。
'"environmentVariables"': (可选) 环境变量配置。如果您选择通过环境变量配置 Targetprocess 连接信息，请在此处配置，或者直接在运行 MCP 客户端的环境中设置这些环境变量。注意：如果使用配置文件 'config/targetprocess.json'，则不需要在此处配置环境变量。

请注意: MCP 客户端需要能够执行 'node build/index.js' 命令来启动 Targetprocess MCP 服务器。请确保客户端环境已安装 Node.js，并且 'node' 命令在系统的 PATH 环境变量中。

基本使用方法

启动服务器: 配置完成后，MCP 客户端将使用您提供的命令启动 Targetprocess MCP 服务器。服务器成功启动后，会在控制台输出 "Target Process MCP server running on stdio" 等信息。
通过 MCP 客户端与 Targetprocess 交互: 您可以使用支持 MCP 协议的 AI 客户端 (例如 Cline, Claude Desktop, Goose) 向 Targetprocess MCP 服务器发送请求，调用其提供的工具，例如 'search_entities' (搜索实体), 'get_entity' (获取实体), 'create_entity' (创建实体), 'update_entity' (更新实体), 'inspect_object' (检查对象) 等。

工具调用示例: 以 'search_entities' 工具为例，您可以发送如下格式的 JSON-RPC 请求 (具体请求方式取决于您使用的 MCP 客户端)：

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "search_entities",
    "arguments": {
      "type": "UserStory",
      "where": "EntityState.Name eq 'Open'",
      "take": 10
    }
  },
  "id": "1"
}

服务器会处理请求，调用 Targetprocess API 搜索用户故事，并将结果以 JSON-RPC 响应的形式返回给客户端。

更多工具的详细参数和使用方法，请参考仓库 'README.md' 文件中 "API Capabilities" 部分的描述。

文档搜索工具

仓库包含 Targetprocess 开发者文档的本地搜索工具，位于 'resources/target-process-docs' 目录。您可以按照 'README.md' 中的说明使用该工具搜索 Targetprocess API 文档。

关键词