Qase Test Management

Official

by qase-tms · TypeScript

Official MCP server for Qase — manage test cases, runs, suites, defects via AI tools.

Manage test cases, runs, suites and defects in Qase testing platform.

README.md15 KBView on GitHub

Qase MCP Server

Official Model Context Protocol (MCP) server for Qase Test Management Platform.

Overview

The Qase MCP Server provides seamless integration between AI assistants (Claude, Cursor, etc.) and the Qase Test Management Platform. It enables AI assistants to interact with your test cases, test runs, defects, and other Qase entities through a standardized protocol.

Features

✅ Complete Qase API Coverage - Access all Qase entities and operations
✅ QQL Support - Powerful Qase Query Language for advanced searches
✅ Type-Safe - Full TypeScript implementation with comprehensive validation
✅ Custom Domains - Support for enterprise custom domains

Supported Entities

The server provides tools for managing:

Projects - Create and manage test projects
Test Cases - Create, update, and organize test cases
Test Suites - Organize tests into hierarchical suites
Test Runs - Execute test runs and track progress
Test Results - Record and analyze test execution results
Test Plans - Define and manage test plans
Defects - Track and manage bugs
Milestones - Organize work by sprints/releases
Environments - Manage test environments
Shared Steps - Create reusable test steps
Shared Parameters - Define reusable test data
Attachments - Upload and manage files
Custom Fields - Define custom metadata
Configurations - Manage test configurations
Users - User management operations
QQL Search - Advanced cross-project queries

Installation

Prerequisites

Node.js 18+
Qase account with API token (Get your token)

Option 1: Install from NPM (Recommended)

bash

npm install -g @qase/mcp-server

Option 2: Install from Source (Development)

bash

# Clone the repository
git clone https://github.com/qase-tms/qase-mcp-server.git
cd qase-mcp-server

# Install dependencies
npm install

# Build the server
npm run build

Configuration

Environment Variables

Create a .env file or set environment variables:

bash

# Required: Your Qase API token
QASE_API_TOKEN=your_api_token_here

# Optional: Custom API domain for enterprise customers
QASE_API_DOMAIN=api.qase.io

Get your API token from: https://app.qase.io/user/api/token

Custom Domains (Enterprise)

If you're using Qase Enterprise with a custom domain:

bash

QASE_API_DOMAIN=api.yourcompany.qase.io

Integration

Claude Desktop

Add to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

json

{
  "mcpServers": {
    "qase": {
      "command": "npx",
      "args": ["-y", "@qase/mcp-server"],
      "env": {
        "QASE_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

Or, if installed from source:

json

{
  "mcpServers": {
    "qase": {
      "command": "node",
      "args": ["/absolute/path/to/qase-mcp-server/build/index.js"],
      "env": {
        "QASE_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

Cursor

Open Cursor Settings
Navigate to MCP settings
Add the Qase MCP server:

json

{
  "mcpServers": {
    "qase": {
      "command": "npx",
      "args": ["-y", "@qase/mcp-server"],
      "env": {
        "QASE_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

Claude Code

You can add the Qase MCP server to Claude Code using the CLI command:

bash

claude mcp add qase -- npx -y @qase/mcp-server

Set the required environment variable:

bash

export QASE_API_TOKEN=your_api_token_here

Alternatively, add a .mcp.json file to your project root for automatic project-scoped configuration:

json

{
  "mcpServers": {
    "qase": {
      "command": "npx",
      "args": ["-y", "@qase/mcp-server"],
      "env": {
        "QASE_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

You can also use the --scope flag to choose where the configuration is stored:

bash

# Project-scoped (saved in .mcp.json)
claude mcp add --scope project qase -- npx -y @qase/mcp-server

# User-scoped (available in all projects)
claude mcp add --scope user qase -- npx -y @qase/mcp-server

OpenAI Codex CLI

Codex CLI uses TOML configuration. Add the Qase MCP server to ~/.codex/config.toml (global) or .codex/config.toml in your project root:

toml

[mcp_servers.qase]
command = "npx"
args = ["-y", "@qase/mcp-server"]

[mcp_servers.qase.env]
QASE_API_TOKEN = "your_api_token_here"

Note: The section name mcp_servers must use an underscore — mcp-servers or mcpservers will be silently ignored.

OpenCode

Add an opencode.json file to your project root (or ~/.config/opencode/opencode.json for global configuration):

json

{
  "mcp": {
    "qase": {
      "type": "local",
      "command": ["npx", "-y", "@qase/mcp-server"],
      "environment": {
        "QASE_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

Note: OpenCode uses a different format from other MCP clients — the command and args are combined into a single command array, env vars go under environment, and servers are nested under mcp (not mcpServers).

Usage Examples

Basic Operations

List All Projects

code

Can you list all my Qase projects?

Create a Test Case

code

Create a test case in project DEMO titled "Login with valid credentials" with steps for entering username, password, and clicking login

Search with QQL

code

Find all failed test results from the last 7 days in project DEMO

Advanced QQL Queries

Find Flaky Tests

code

Search for all flaky test cases in project DEMO that are not automated

The server will execute:

code

entity = "case" and project = "DEMO" and isFlaky = true and automation = "Not automated"

Find Open Blocker Defects

code

Show me all open blocker defects in project DEMO

Find Tests by Author

code

Find all test cases created by john@example.com in the last month

Working with Test Runs

Create and Execute a Test Run

code

Create a test run in project DEMO called "Sprint 24 Regression" including all test cases from the "Authentication" suite, then add a passed result for case ID 123

Available Tools

Projects (6 tools)

list_projects - Get all projects
get_project - Get project details
create_project - Create new project
delete_project - Delete project
grant_project_access - Grant user/group access
revoke_project_access - Revoke access

Test Cases (8 tools)

list_cases - List all test cases
get_case - Get test case details
create_case - Create new test case
update_case - Update test case
delete_case - Delete test case
bulk_create_cases - Create multiple cases
attach_external_issue - Link external issue (Jira, etc.)
detach_external_issue - Unlink external issue

Case enum values

create_case, bulk_create_cases, and update_case automatically normalize friendly labels to whatever numeric IDs your workspace currently configures for the built-in system fields (priority, severity, type, behavior, status, layer). The server fetches /v1/system_field and caches the available options so you can keep using the titles or slugs you see in Qase while still satisfying the API’s numeric requirements.

The normalization does not touch automation/is_flaky, so pass those values as the API expects (strings or booleans). The server keeps any existing label in place when it does not match a known enum so invalid values still bubble up as errors from Qase.

Test Runs (7 tools)

list_runs - List test runs
get_run - Get run details
create_run - Create new run
delete_run - Delete run
complete_run - Mark run as complete
get_run_public_link - Get public link
delete_run_public_link - Remove public link

Test Results (6 tools)

list_results - List test results
get_result - Get result details
create_result - Create test result
create_results_bulk - Create multiple results
update_result - Update result
delete_result - Delete result

Test Plans (5 tools)

list_plans - List test plans
get_plan - Get plan details
create_plan - Create test plan
update_plan - Update test plan
delete_plan - Delete test plan

Suites (5 tools)

list_suites - List suites
get_suite - Get suite details
create_suite - Create suite
update_suite - Update suite
delete_suite - Delete suite

Defects (7 tools)

list_defects - List defects
get_defect - Get defect details
create_defect - Create defect
update_defect - Update defect
delete_defect - Delete defect
resolve_defect - Mark as resolved
update_defect_status - Update status

Milestones (5 tools)

list_milestones - List milestones
get_milestone - Get milestone details
create_milestone - Create milestone
update_milestone - Update milestone
delete_milestone - Delete milestone

Environments (5 tools)

list_environments - List environments
get_environment - Get environment details
create_environment - Create environment
update_environment - Update environment
delete_environment - Delete environment

Shared Steps (5 tools)

list_shared_steps - List shared steps
get_shared_step - Get shared step details
create_shared_step - Create shared step
update_shared_step - Update shared step
delete_shared_step - Delete shared step

Shared Parameters (5 tools)

list_shared_parameters - List parameters
get_shared_parameter - Get parameter details
create_shared_parameter - Create parameter
update_shared_parameter - Update parameter
delete_shared_parameter - Delete parameter

Supporting Entities

Attachments (4 tools) - File management
Authors (2 tools) - Author information
Custom Fields (5 tools) - Custom field management
System Fields (1 tool) - System field info
Configurations (3 tools) - Configuration management
Users (2 tools) - User management

QQL Search (2 tools)

qql_search - Execute QQL query
qql_help - Get QQL syntax help

Total: 83 tools available

Development

Building from Source

bash

npm run build

Running Tests

bash

# Run all tests
npm test

# Run with coverage
npm run test:coverage

# Watch mode
npm run test:watch

Linting

bash

# Check for issues
npm run lint

# Auto-fix issues
npm run lint -- --fix

Debugging

Use the MCP Inspector for interactive debugging:

bash

npm run inspector

Set your API token when prompted, then interact with tools in the inspector UI.

Transport Options

The server supports multiple transport types for different use cases:

Stdio Transport (Default)

Used by MCP clients like Claude Desktop and Cursor:

bash

npm start
# or
npm run start:stdio

SSE Transport

Server-Sent Events for web-based clients:

bash

npm run start:sse
# Server runs on http://localhost:3000/sse
# Health check: http://localhost:3000/health

Streamable HTTP Transport

Full HTTP-based transport with session management:

bash

npm run start:http
# Server runs on http://localhost:3000/mcp
# Health check: http://localhost:3000/health

Custom Configuration

bash

# Custom port and host
node build/index.js --transport streamable-http --port 8080 --host 0.0.0.0

# Available options:
# --transport: stdio | sse | streamable-http (default: stdio)
# --port: Port number (default: 3000)
# --host: Host address (default: 0.0.0.0)

Troubleshooting

Authentication Errors

Error: Authentication failed: Please check your QASE_API_TOKEN

Solution:

Verify your API token is correct: https://app.qase.io/user/api/token
Ensure the token is set in your environment or config file
Check for extra spaces or quotes in the token value

Connection Errors

Error: Network error or ECONNREFUSED

Solution:

Check your internet connection
Verify the API domain is correct (especially for enterprise customers)
Check if Qase is accessible: https://api.qase.io/v1/

SSL Certificate Errors

Error: unable to get local issuer certificate

This error typically occurs in corporate environments with:

SSL-intercepting proxy servers
Self-signed certificates
Internal Certificate Authorities (CA)

Solution: Add the NODE_EXTRA_CA_CERTS environment variable pointing to your CA certificate file:

json

{
  "mcpServers": {
    "qase": {
      "command": "npx",
      "args": ["-y", "@qase/mcp-server"],
      "env": {
        "QASE_API_TOKEN": "your_api_token_here",
        "NODE_EXTRA_CA_CERTS": "/path/to/your/certificate.pem"
      }
    }
  }
}

To find your certificate:

Corporate environments: Contact your IT department for the CA certificate
macOS: Export from Keychain Access (System Roots → your CA → Export as .pem)
Windows: Export from Certificate Manager (certmgr.msc)
Linux: Usually in /etc/ssl/certs/ or /etc/pki/tls/certs/

Custom Domain Issues

Error: Invalid domain or connection errors with custom domain

Solution:

Ensure QASE_API_DOMAIN is set to just the domain (e.g., api.company.qase.io)
Don't include https:// or /v1 in the domain
Verify with your Qase administrator

No Tools Showing in MCP Client

Error: MCP client shows "no tools, prompts or resources" or 0 tools available

Solution:

Verify your MCP configuration has the correct command and arguments
Check that QASE_API_TOKEN is set in the env section
Restart your MCP client completely (close and reopen)
Check the MCP client logs for connection errors
Verify the server is built: npm run build

Tool Not Found

Error: Unknown tool: tool_name

Solution:

Ensure you're using the latest version: npm update -g @qase/mcp-server
Check the tool name spelling matches the documentation
Restart your MCP client after updating

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

Development Guidelines

Follow TypeScript best practices
Add unit tests for new features
Update documentation for new tools
Ensure all tests pass: npm test
Ensure linting passes: npm run lint
Maintain code coverage above 70%

License

MIT License - see LICENSE file for details

Support

Documentation: https://help.qase.io
Email: support@qase.io
GitHub Issues: https://github.com/qase-tms/qase-mcp-server/issues

Made with ❤️ by Qase

Install

Configuration

Environment variables

QASE_API_TOKENrequiredsecret

Qase API token from app.qase.io > Settings > API Tokens

QASE_API_DOMAINdefault api.qase.io

Custom API domain for enterprise (default: api.qase.io)

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "@qase/mcp-server@1.1.8"
      ],
      "env": {
        "QASE_API_TOKEN": "<YOUR_QASE_API_TOKEN>",
        "QASE_API_DOMAIN": "api.qase.io"
      }
    }
  }
}

Qase MCP Server

Overview

Features

Supported Entities

Installation

Prerequisites

Option 1: Install from NPM (Recommended)

Option 2: Install from Source (Development)

Configuration

Environment Variables

Custom Domains (Enterprise)

Integration

Claude Desktop

Cursor

Claude Code

OpenAI Codex CLI

OpenCode

Usage Examples

Basic Operations

List All Projects

Create a Test Case

Search with QQL

Advanced QQL Queries

Find Flaky Tests

Find Open Blocker Defects

Find Tests by Author

Working with Test Runs

Create and Execute a Test Run

Available Tools

Projects (6 tools)

Test Cases (8 tools)

Case enum values

Test Runs (7 tools)

Test Results (6 tools)

Test Plans (5 tools)

Suites (5 tools)

Defects (7 tools)

Milestones (5 tools)

Environments (5 tools)

Shared Steps (5 tools)

Shared Parameters (5 tools)

Supporting Entities

QQL Search (2 tools)

Development

Building from Source

Running Tests

Linting

Debugging

Transport Options

Stdio Transport (Default)

SSE Transport

Streamable HTTP Transport

Custom Configuration

Troubleshooting

Authentication Errors

Connection Errors

SSL Certificate Errors

Custom Domain Issues

No Tools Showing in MCP Client

Tool Not Found

Contributing

Development Guidelines

License

Links

Support

Install

Configuration