TM

testomatio/mcp

API development
7 stars 0 forks Качество 90 Тренд 90

Model Context Protocol (MCP) server that enables AI assistants (Claude, Cursor, OpenCode, etc.) to interact with Testomat.io Public API v2.

Обзор

Model Context Protocol (MCP) server that enables AI assistants (Claude, Cursor, OpenCode, etc.) to interact with Testomat.io Public API v2.

README

Testomat.io MCP Server

Model Context Protocol (MCP) server that enables AI assistants (Claude, Cursor, OpenCode, etc.) to interact with Testomat.io Public API v2.

Features

  • Full CRUD for core entities:
    • Tests, Suites, Plans, Runs, TestRuns, RunGroups, Steps, Snippets, Labels
    • Tags and Milestones (read-only access)
    • Issues (global + scoped helpers for tests/suites/runs/testruns/plans)
    • Attachments (scoped helpers for tests/suites/testruns)
    • Requirements (including file uploads from local file paths)
  • Issue Linking - link/unlink issues to any resource
  • API Compatibility - automatic handling of payload format differences (flat vs wrapped)
  • Automatic API Sessions - groups MCP changes in Testomat.io history using API sessions
  • Run Management - status transitions via status_event parameter
  • TQL-Only Search - tests_list and runs_list use tql as the single search/filter input
  • Built-In TQL Reference - MCP tool descriptions include exact TQL fields, syntax, and examples for agents

Quick Start

Installation

npm install -g @testomatio/mcp@latest

Need enterprise analytics tools? Install @testomatio/mcp-enterprise@latest instead. Details are in the Enterprise Analytics section below.

Configuration

Required credentials:

  • TESTOMATIO_PROJECT_TOKEN - Your project API token
  • TESTOMATIO_PROJECT_ID - Your project ID

Run server:

testomatio-mcp --token  --project 

Or with environment variables:

export TESTOMATIO_PROJECT_TOKEN=
export TESTOMATIO_PROJECT_ID=
testomatio-mcp

Optional: custom base URL

export TESTOMATIO_BASE_URL=https://beta.testomat.io

Usage with AI Assistants

Cursor IDE

Add this config to .cursor/mcp.json in your project, or to ~/.cursor/mcp.json for global access:

{
  "mcpServers": {
    "testomatio": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@testomatio/mcp@latest",
        "--token",
        "",
        "--project",
        ""
      ],
      "env": {
        "TESTOMATIO_BASE_URL": "https://app.testomat.io"
      }
    }
  }
}

Claude Desktop

Add this config to:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "testomatio": {
      "command": "npx",
      "args": [
        "-y",
        "@testomatio/mcp@latest",
        "--token",
        "",
        "--project",
        ""
      ],
      "env": {
        "TESTOMATIO_BASE_URL": "https://app.testomat.io"
      }
    }
  }
}

OpenCode

Add this config to opencode.json in your project root, or to ~/.config/opencode/opencode.json for global access:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "testomat": {
      "type": "local",
      "command": [
        "npx",
        "-y",
        "@testomatio/mcp@latest",
        "--token",
        "",
        "--project",
        ""
      ],
      "enabled": true,
      "environment": {
        "TESTOMATIO_BASE_URL": "https://app.testomat.io"
      }
    }
  }
}

Quick Examples

List tests:

{
  "name": "tests_list",
  "arguments": { "page": 1, "per_page": 50, "tql": "priority == 'high'" }
}

Create test:

{
  "name": "tests_create",
  "arguments": {
    "title": "User login test",
    "suite_id": "123",
    "priority": "high"
  }
}

Create run:

{
  "name": "runs_create",
  "arguments": {
    "title": "Smoke tests",
    "kind": "automated",
    "env": "production"
  }
}

Finish run:

{
  "name": "runs_update",
  "arguments": {
    "run_id": "456",
    "status_event": "finish"
  }
}

Upload attachment to a test:

{
  "name": "tests_attachments_upload",
  "arguments": {
    "test_id": "123",
    "file_path": "/path/to/screenshot.png"
  }
}

Documentation

Complete tool reference: docs/tools.md

Project Structure

src/
|- config/          # Config loading, defaults
|- core/            # Errors, logger
|- api/             # HTTP client, Testomat.io API client
|- mcp/             # MCP server, tools, registry
|  |- definitions/  # Tool definitions by entity
|  |- configs/      # Registry generation configs
|  `- registry/     # Tool handlers
`- cli/             # CLI bootstrap

Environment Variables

Variable Required Default Description
TESTOMATIO_PROJECT_TOKEN Yes* - Project token (preferred)
TESTOMATIO_API_TOKEN Yes* - Alternative token
TESTOMATIO_PROJECT_ID Yes - Project ID
TESTOMATIO_BASE_URL No https://app.testomat.io API base URL

*Either TESTOMATIO_PROJECT_TOKEN or TESTOMATIO_API_TOKEN

Corporate TLS Certificates

If the MCP server runs behind a corporate proxy or TLS inspection, Node.js may reject Testomat.io HTTPS requests even when the same URL works in a browser. This usually means the company root certificate is trusted by the operating system, but not by Node.js.

Use Node.js system CA support:

NODE_OPTIONS=--use-system-ca testomatio-mcp --token  --project 

For MCP clients, pass NODE_OPTIONS in the server environment:

{
  "mcpServers": {
    "testomatio": {
      "command": "testomatio-mcp",
      "args": ["--token", "", "--project", ""],
      "env": {
        "NODE_OPTIONS": "--use-system-ca"
      }
    }
  }
}

If your Node.js version does not support --use-system-ca, export the corporate root certificate to a PEM file and use Node.js extra CA support:

NODE_EXTRA_CA_CERTS=/path/to/company-root-ca.pem testomatio-mcp --token  --project 

Important Notes

  • Run Status - Use runs_update with status_event for transitions (finish, launch, rerun, etc.)
  • Search/Filter - No dedicated /search endpoints; filtering is done via the *_list tools (tql for tests and runs, OpenAPI-aligned filters for other entities)
  • TQL - Use tql as the single search/filter input for tests_list and runs_list
  • TQL Syntax - For user-facing syntax details and more examples, see the official TQL docs: https://docs.testomat.io/advanced/tql/
  • TQL Scope - The full agent-oriented whitelist of documented fields lives inside MCP tool descriptions for tests and runs
  • Issue Linking - Scoped helpers available: {entity}_issues_link/unlink
  • Attachments - Scoped helpers available for tests, suites, and testruns: {entity}_attachments_list/upload/delete. Upload sends one local file path as multipart field file.
  • Enterprise Package - Analytics tools are intentionally exposed only by @testomatio/mcp-enterprise, not by the standard @testomatio/mcp package
  • API Sessions - The server automatically starts a Testomat.io session before the first POST, PUT, or DELETE request, sends the returned session hash as X-Session-Hash on later mutating requests, and stops the session when the MCP server shuts down. GET requests do not start or use sessions.

Development

npm install
npm run start -- --token  --project 

For local MCP development, point Claude Desktop to the checked-out entrypoint:

{
  "mcpServers": {
    "testomatio-local": {
      "command": "node",
      "args": ["/path/to/mcp/index.js", "--token", "", "--project", ""]
    }
  }
}

Enterprise Analytics

Enterprise analytics is available only in the separate @testomatio/mcp-enterprise package.

Installation:

npm install -g @testomatio/mcp-enterprise@latest

Run:

testomatio-mcp-enterprise --token  --project 

Included tools:

  • analytics_tests - GET /api/v2/{project_id}/analytics/tests/{kind}
  • analytics_stats - GET /api/v2/{project_id}/analytics/stats/{kind}

Analytics endpoints require the api_analytics subscription feature. Use q as the TQL filter parameter for analytics tools.

Example analytics_tests call:

{
  "name": "analytics_tests",
  "arguments": {
    "kind": "flaky",
    "q": "priority == 'high'",
    "days": 30,
    "page": 1,
    "per_page": 20
  }
}

Example analytics_stats call:

{
  "name": "analytics_stats",
  "arguments": {
    "kind": "success-rate-by-date",
    "q": "tag IN ['@smoke']",
    "from": "2026-04-01",
    "to": "2026-04-30"
  }
}
View this README on GitHub

Установка

npx -y @testomatio/mcp@latest --token <TOKEN> --project <PROJECT_ID>

Конфигурация

{ "mcpServers": { "testomatio": { "type": "stdio", "command": "npx", "args": [ "-y", "@testomatio/mcp@latest", "--token", "<TOKEN>", "--project", "<PROJECT_ID>" ], "env": { "TESTOMATIO_BASE_URL": "https://app.testomat.io" } } } }