Skip to content

TCSoftInc/testcollab-mcp-server

Repository files navigation

TestCollab MCP Server

Connect your AI coding assistant to TestCollab — manage test cases, test plans, and suites directly from Claude, Cursor, Windsurf, Codex, or any MCP-compatible client.

Quick Start

1. Get your API token

Log in to TestCollab → My Profile SettingsAPI Token tab → Generate new API token.

2. Add the server to your MCP client

Claude Code — add to .mcp.json in your project root:

{
  "mcpServers": {
    "testcollab": {
      "command": "npx",
      "args": ["-y", "@testcollab/mcp-server"],
      "env": {
        "TC_API_TOKEN": "your-api-token",
        "TC_API_URL": "https://api.testcollab.io",
        "TC_DEFAULT_PROJECT": "16"
      }
    }
  }
}

Claude Desktop — add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "testcollab": {
      "command": "npx",
      "args": ["-y", "@testcollab/mcp-server"],
      "env": {
        "TC_API_TOKEN": "your-api-token",
        "TC_API_URL": "https://api.testcollab.io",
        "TC_DEFAULT_PROJECT": "16"
      }
    }
  }
}

Cursor — add to .cursor/mcp.json in your project root:

{
  "mcpServers": {
    "testcollab": {
      "command": "npx",
      "args": ["-y", "@testcollab/mcp-server"],
      "env": {
        "TC_API_TOKEN": "your-api-token",
        "TC_API_URL": "https://api.testcollab.io",
        "TC_DEFAULT_PROJECT": "16"
      }
    }
  }
}

Manual Testing

TC_API_TOKEN=your-token npm start

Available Tools

list_test_cases

List test cases from a project with optional filtering.

Parameters:

Name Type Required Description
project_id number No* Project ID (*required if TC_DEFAULT_PROJECT not set)
suite number|string No Filter by suite ID or title
filter object No Filter conditions
sort array No Sort specification
limit number No Max results (1-100, default: 50)
offset number No Skip N results (default: 0)

3. Verify

Restart your client, then ask: "What tools do you have for TestCollab?"

You should see the TestCollab tools listed. Try: "Show me all test cases".

Configuration

Variable Required Default Description
TC_API_TOKEN Yes API token from your TestCollab profile
TC_API_URL No https://api.testcollab.io TestCollab API base URL
TC_DEFAULT_PROJECT No Default project ID (makes project_id optional in every tool call)

EU region: If your TestCollab account is hosted in the EU, use https://api-eu.testcollab.io as your TC_API_URL.

What You Can Do

Tool Description
get_project_context Get suites, tags, custom fields, requirements, test plan folders, releases, users — call this first
list_test_cases Query test cases with filtering, sorting, and pagination
get_test_case Fetch a test case with full step details
create_test_case Create a test case with steps, tags, custom fields
update_test_case Update any test case field
list_test_plans List test plans with filtering/sorting (including release ID/title filters)
get_test_plan Fetch one test plan with included test cases count, configurations, runs, current progress status, and release info
create_test_plan Create a test plan with cases, configurations, assignment, and optional release association
update_test_plan Update test plan metadata, status, assignment, and release association
delete_test_plan Delete a test plan
list_suites List all test suites in a project (supports title, parent, and description filters)
get_suite Get suite details
create_suite Create a new suite
update_suite Update a suite
delete_suite Delete a suite
move_suite Move a suite to a different parent
reorder_suites Reorder suites within a parent

Example Prompts

"Show me all high-priority test cases in the Login suite"

"Create a test case for verifying password reset with 5 steps"

"List all test plans created this week"

"Create a regression test plan with all test cases tagged 'smoke'"

"Move the Payment suite under the Checkout suite"

See Use Cases for detailed workflows.

Local Development Setup

If you're contributing or want to run from source instead of npx:

git clone <repo-url>
cd tc-mcp-server
npm install
npm run build

Then point your MCP client to the built file:

{
  "mcpServers": {
    "testcollab": {
      "command": "node",
      "args": ["/path/to/tc-mcp-server/dist/index.js"],
      "env": {
        "TC_API_TOKEN": "your-api-token",
        "TC_API_URL": "http://localhost:1337",
        "TC_DEFAULT_PROJECT": "16"
      }
    }
  }
}

Dev Commands

npm run dev          # Watch mode with hot reload
npm run build        # Compile TypeScript
npm test             # Run tests
npm run typecheck    # Type check
npm run lint         # Lint

Troubleshooting

Server not appearing in your client

  • Restart the client after adding the config
  • Verify Node.js 20+ is installed: node --version
  • Test manually: TC_API_TOKEN=your-token npx @testcollab/mcp-server

Authentication errors

  • Verify your API token is valid and not expired
  • Check that TC_API_URL points to the correct server

"project_id is required" error

  • Set TC_DEFAULT_PROJECT in your env config, or
  • Specify the project in your prompt: "Show me test cases in project 16"

License

MIT

About

MCP server for TestCollab test management. Lets AI coding assistants (Claude Code, Cursor, Windsurf, Codex) create, update, and query test cases, create test plans, and suite hierarchy. Connect your AI workflow to your QA process.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors