Targetprocess

🚀 Target Process MCP Server Documentation

Target Process MCP Server enables seamless interaction with Targetprocess via command - line or desktop apps, facilitating integration with AI assistants.

🚀 Quick Start

Targetprocess is a powerful project management tool used to track and manage various work items such as user stories, tasks, and defects. To facilitate integration with AI assistants, we offer the Targetprocess Model Context Protocol (MCP) server, which allows interaction with Targetprocess through the command line or desktop applications.

✨ Features

Search Entities

Search for entities (user stories, tasks, defects, etc.) in Targetprocess.

{
  "type": "UserStory",
  "where": "EntityState.Name eq 'Open'",
  "take": 10,
  "include": ["Project", "Team"]
}

Get Entity Details

Retrieve detailed information about a specific entity.

{
  "type": "UserStory",
  "id": 123456,
  "include": ["Project", "Team"]
}

Create Entity

Create a new entity in Targetprocess.

{
  "type": "UserStory",
  "name": "Story Name",
  "description": "Detailed description...",
  "project": { "id": 123 },
  "team": { "id": 456 }
}

Update Entity

Update an existing entity in Targetprocess.

{
  "type": "UserStory",
  "id": 123456,
  "name": "Updated Name",
  "description": "Updated description..."
}

📦 Installation

Install with Docker (Recommended)

1. Clone the repository:

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

2. Build the image and start the container:

   docker build -t targetprocess-mcp .
   docker run -it -p 3000:3000 targetprocess-mcp
   

Local Installation

1. Clone the repository and extract it.
2. Install dependencies:

   npm install
   

3. Configure environment variables or create a configuration file.
4. Run the server:

   node build/index.js
   

📚 Documentation

Configuration Options

Environment Variables

TARGETPROCESS_DOMAIN=your-domain.tpondemand.com
TARGETPROCESS_USERNAME=your-username
TARGETPROCESS_PASSWORD=your-password

Configuration File

Create a config/targetprocess.json file:

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

Performance Considerations

• Limit the number of results: Use the take parameter to control the number of returned results.
• Optimize filtering conditions: Use the where condition reasonably to improve query efficiency.
• Include only necessary data: Select the required associated data through the include parameter to avoid unnecessary loading.

LLM Integration

Supports integration with the following tools:

• Cline: A command - line interface tool.
• Claude Desktop: A desktop AI tool.
• Goose: Other compatible tools.

API Endpoints

Search Entities

POST /api/entities/search

Get Entity Details

GET /api/entities/{id}

Create Entity

POST /api/entities

Update Entity

PUT /api/entities/{id}

🔧 Technical Details

Target Users

• Developers: Those who want to interact with Targetprocess through scripts or automation tools.
• Project administrators: Those who want to use AI tools to assist with project management tasks.
• Data analysts: Those who need to extract and analyze data from Targetprocess.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

With the above documentation, you can easily integrate Targetprocess with AI tools to improve project management efficiency.