PingCode

Provides access to PingCode project data and enables work item, release, and search operations via MCP clients.

typescript

0

GitHub Stars

typescript

Language

6 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "ratatatat1-pingcode-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "pingcode-mcp"
      ]
    }
  }
}

PingCode MCP Server lets your AI assistants query PingCode project data such as work items, releases, defects, and requirements. It enables seamless, browser-based login and fast access to project information through an MCP client.

How to use

You run the MCP server on your machine and connect to it from your MCP client (like Windsurf, Cursor, or Claude Desktop). Once connected, you can log in, fetch work item details by identifier, list project releases, search work items, and inspect release-related items such as defects or stories. Use natural language prompts to ask for specific items or to filter results, and the AI will query PingCode data through the MCP server.

Typical usage patterns include: asking for a work item by its key (for example, LFY-2527) to see its details, listing all releases for a project, retrieving defects associated with a release, or searching for work items containing a keyword. You will log in once via the assistant’s login flow; credentials are stored locally for subsequent requests.

How to install

Prerequisites: ensure you have Node.js and npm installed on your system.

Option A: Global installation (recommended)

npm install -g pingcode-mcp

"""


After installing, install Chromium for browser-based login.

npx playwright install chromium


Option B: Use with npx (no installation required)

npx pingcode-mcp


First run may download dependencies automatically.

## Additional configuration and usage notes

Configure your MCP client to connect to the PingCode MCP Server. You can choose either the global installation path or the npx path, depending on how you started the server.

Example configurations for MCP clients are shown below. These enable the client to launch the server either from a global installation or via npx.

{ "mcpServers": { "pingcode-mcp": { "command": "pingcode-mcp" } } }

{ "mcpServers": { "pingcode-mcp": { "command": "npx", "args": ["-y", "pingcode-mcp"] } } }

## First login and credential storage

After you restart your MCP client, trigger the login flow so the assistant can authenticate with PingCode. The browser will open to complete authorization, and credentials will be saved locally.

## Available tools

### login

Open browser to authenticate with PingCode and store credentials locally.

### logout

Clear stored credentials from the local machine.

### check\_auth

Check whether current credentials are valid and active.

### get\_work\_item

Fetch details for a specific work item by its identifier (e.g., LFY-123).

### list\_projects

List all projects you have access to through the MCP server.

### list\_releases

List all releases for a given project.

### get\_release\_items

Retrieve work items associated with a specific release. Supports filtering by type (bug, story, all).

### search\_work\_items

Search work items by a query string, optionally restricted to a project.

### update\_work\_item\_state

Update the state of a work item by its ID.