testrail-mcp-server
mcpkey · packageConnect AI assistants to TestRail: manage test cases, suites, runs, results, and attachments.
run it
on your own machines, one way per deploy method#!/usr/bin/env bash # testrail (io.github.uarlouski/testrail-mcp-server), recipe baremetal (generated). # Generated by Hub for toolset "my-agent"; started by mcp-my-agent-testrail.service. set -euo pipefail export HOST=127.0.0.1 PORT=8101 exec npx -y supergateway@4 --stdio 'npx -y @uarlouski/[email protected]' --outputTransport streamableHttp --stateful --host 127.0.0.1 --port 8101 --streamableHttpPath /mcp --healthEndpoint /healthz [Unit] Description=MCP server testrail (toolset my-agent), generated by Hub After=network-online.target Wants=network-online.target [Service] Type=simple User=mcp Group=mcp EnvironmentFile=/etc/mcp/my-agent.env Environment=HOME=/var/lib/mcp/testrail WorkingDirectory=/var/lib/mcp/testrail ExecStart=/opt/mcp/my-agent/bin/testrail.sh Restart=on-failure RestartSec=5 NoNewPrivileges=true ProtectSystem=strict ProtectHome=true PrivateTmp=true ReadWritePaths=/var/lib/mcp/testrail [Install] WantedBy=multi-user.target
docker run --rm -p 127.0.0.1:8101:8000 -e TESTRAIL_INSTANCE_URL -e TESTRAIL_USERNAME -e TESTRAIL_API_KEY -e TESTRAIL_ENABLE_SHARED_STEPS -e TESTRAIL_ENABLE_CASE_HISTORY -e TESTRAIL_ENABLE_RAG_TOOLS -e TESTRAIL_ALLOW_WRITE_OPERATIONS -e TESTRAIL_ALLOW_READ_OPERATIONS -e TESTRAIL_ALLOW_DELETE_OPERATIONS -e TESTRAIL_ENABLE_DEPRECATED_TOOLS -e TESTRAIL_DISABLED_TOOLS -e TESTRAIL_REQUEST_TIMEOUT_MS node:22-alpine sh -c 'npx -y supergateway@4 --stdio '"'"'npx -y @uarlouski/[email protected]'"'"' --outputTransport streamableHttp --stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz'
# Generated by Hub for toolset "my-agent" (2026-10-18T13:32:39+00:00).
# Each package server runs behind a stdio->HTTP bridge and listens on localhost only.
# cp .env.example .env # fill the ${VAR}s
# docker compose up -d && bash smoke.sh
# Remote servers are not here: clients reach them directly (see clients/).
name: mcp-my-agent
services:
testrail:
image: node:22-alpine
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @uarlouski/[email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
ports:
- 127.0.0.1:8101:8000
volumes:
- npm-cache:/root/.npm
healthcheck:
test:
- CMD-SHELL
- wget -qO- http://127.0.0.1:8000/healthz || exit 1
interval: 30s
timeout: 5s
retries: 5
start_period: 2m
restart: unless-stopped
environment:
TESTRAIL_INSTANCE_URL: ${TESTRAIL_INSTANCE_URL}
TESTRAIL_USERNAME: ${TESTRAIL_USERNAME}
TESTRAIL_API_KEY: ${TESTRAIL_API_KEY}
TESTRAIL_ENABLE_SHARED_STEPS: ${TESTRAIL_ENABLE_SHARED_STEPS}
TESTRAIL_ENABLE_CASE_HISTORY: ${TESTRAIL_ENABLE_CASE_HISTORY}
TESTRAIL_ENABLE_RAG_TOOLS: ${TESTRAIL_ENABLE_RAG_TOOLS}
TESTRAIL_ALLOW_WRITE_OPERATIONS: ${TESTRAIL_ALLOW_WRITE_OPERATIONS}
TESTRAIL_ALLOW_READ_OPERATIONS: ${TESTRAIL_ALLOW_READ_OPERATIONS}
TESTRAIL_ALLOW_DELETE_OPERATIONS: ${TESTRAIL_ALLOW_DELETE_OPERATIONS}
TESTRAIL_ENABLE_DEPRECATED_TOOLS: ${TESTRAIL_ENABLE_DEPRECATED_TOOLS}
TESTRAIL_DISABLED_TOOLS: ${TESTRAIL_DISABLED_TOOLS}
TESTRAIL_REQUEST_TIMEOUT_MS: ${TESTRAIL_REQUEST_TIMEOUT_MS}
volumes:
npm-cache: {}
uv-cache: {}
# Generated by Hub for toolset "my-agent" (2026-10-18T13:32:39+00:00).
# kubectl create namespace mcp
# kubectl -n mcp create secret generic mcp-credentials --from-env-file=.env
# kubectl apply -f kubernetes.yaml
# Services are cluster-internal: <name>.mcp.svc.cluster.local:8000/mcp. Put an ingress
# with auth in front before exposing any of them.
apiVersion: v1
kind: Namespace
metadata:
name: mcp
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: testrail
namespace: mcp
labels: &id001
app: testrail
spec:
replicas: 1
selector:
matchLabels: *id001
template:
metadata:
labels: *id001
spec:
containers:
- name: testrail
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: TESTRAIL_INSTANCE_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_INSTANCE_URL
- name: TESTRAIL_USERNAME
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_USERNAME
- name: TESTRAIL_API_KEY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_API_KEY
- name: TESTRAIL_ENABLE_SHARED_STEPS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ENABLE_SHARED_STEPS
- name: TESTRAIL_ENABLE_CASE_HISTORY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ENABLE_CASE_HISTORY
- name: TESTRAIL_ENABLE_RAG_TOOLS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ENABLE_RAG_TOOLS
- name: TESTRAIL_ALLOW_WRITE_OPERATIONS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ALLOW_WRITE_OPERATIONS
- name: TESTRAIL_ALLOW_READ_OPERATIONS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ALLOW_READ_OPERATIONS
- name: TESTRAIL_ALLOW_DELETE_OPERATIONS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ALLOW_DELETE_OPERATIONS
- name: TESTRAIL_ENABLE_DEPRECATED_TOOLS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ENABLE_DEPRECATED_TOOLS
- name: TESTRAIL_DISABLED_TOOLS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_DISABLED_TOOLS
- name: TESTRAIL_REQUEST_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_REQUEST_TIMEOUT_MS
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @uarlouski/[email protected]' --outputTransport
streamableHttp --stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint
/healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
---
apiVersion: v1
kind: Service
metadata:
name: testrail
namespace: mcp
spec:
selector:
app: testrail
ports:
- port: 8000
targetPort: http
name: http
# Generated by Hub for toolset "my-agent" (2026-10-18T13:32:39+00:00).
# Credentials come from the Secret 'mcp-credentials' (kubectl create secret generic ... --from-env-file=.env).
# Each server under `servers` is one Deployment + Service; the keys after it configure
# upstream charts a worker verified.
servers:
testrail:
enabled: true
replicas: 1
port: 8000
path: /mcp
container:
name: testrail
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: TESTRAIL_INSTANCE_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_INSTANCE_URL
- name: TESTRAIL_USERNAME
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_USERNAME
- name: TESTRAIL_API_KEY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_API_KEY
- name: TESTRAIL_ENABLE_SHARED_STEPS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ENABLE_SHARED_STEPS
- name: TESTRAIL_ENABLE_CASE_HISTORY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ENABLE_CASE_HISTORY
- name: TESTRAIL_ENABLE_RAG_TOOLS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ENABLE_RAG_TOOLS
- name: TESTRAIL_ALLOW_WRITE_OPERATIONS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ALLOW_WRITE_OPERATIONS
- name: TESTRAIL_ALLOW_READ_OPERATIONS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ALLOW_READ_OPERATIONS
- name: TESTRAIL_ALLOW_DELETE_OPERATIONS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ALLOW_DELETE_OPERATIONS
- name: TESTRAIL_ENABLE_DEPRECATED_TOOLS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_ENABLE_DEPRECATED_TOOLS
- name: TESTRAIL_DISABLED_TOOLS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_DISABLED_TOOLS
- name: TESTRAIL_REQUEST_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: TESTRAIL_REQUEST_TIMEOUT_MS
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y @uarlouski/[email protected]' --outputTransport
streamableHttp --stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint
/healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
# helm install my-agent helm/my-agent -n mcp
in the cloud
one click: the provider's deploy form opens filled in, in your own account- koyeb
-
The form opens with CHANGE_ME for each value you supply: TESTRAIL_INSTANCE_URL, TESTRAIL_USERNAME, TESTRAIL_API_KEY, TESTRAIL_ENABLE_SHARED_STEPS, TESTRAIL_ENABLE_CASE_HISTORY, TESTRAIL_ENABLE_RAG_TOOLS, TESTRAIL_ALLOW_WRITE_OPERATIONS, TESTRAIL_ALLOW_READ_OPERATIONS, TESTRAIL_ALLOW_DELETE_OPERATIONS, TESTRAIL_ENABLE_DEPRECATED_TOOLS, TESTRAIL_DISABLED_TOOLS, TESTRAIL_REQUEST_TIMEOUT_MS. Fill them in before you deploy.
Clients connect to the service's https://…koyeb.app address plus /mcp.
- azure
-
A Container Apps environment with one app per server, each with HTTPS ingress and one replica. The portal asks for each value you supply as a secure parameter; the deployment's outputs list the endpoints.
connect to it
copy what your client needsnpx -y @uarlouski/[email protected] # env: TESTRAIL_INSTANCE_URL, TESTRAIL_USERNAME, TESTRAIL_API_KEY, TESTRAIL_ENABLE_SHARED_STEPS, TESTRAIL_ENABLE_CASE_HISTORY, TESTRAIL_ENABLE_RAG_TOOLS, TESTRAIL_ALLOW_WRITE_OPERATIONS, TESTRAIL_ALLOW_READ_OPERATIONS, TESTRAIL_ALLOW_DELETE_OPERATIONS, TESTRAIL_ENABLE_DEPRECATED_TOOLS, TESTRAIL_DISABLED_TOOLS, TESTRAIL_REQUEST_TIMEOUT_MS
{
"mcpServers": {
"testrail": {
"command": "npx",
"args": [
"-y",
"@uarlouski/[email protected]"
],
"env": {
"TESTRAIL_INSTANCE_URL": "${TESTRAIL_INSTANCE_URL}",
"TESTRAIL_USERNAME": "${TESTRAIL_USERNAME}",
"TESTRAIL_API_KEY": "${TESTRAIL_API_KEY}",
"TESTRAIL_ENABLE_SHARED_STEPS": "${TESTRAIL_ENABLE_SHARED_STEPS}",
"TESTRAIL_ENABLE_CASE_HISTORY": "${TESTRAIL_ENABLE_CASE_HISTORY}",
"TESTRAIL_ENABLE_RAG_TOOLS": "${TESTRAIL_ENABLE_RAG_TOOLS}",
"TESTRAIL_ALLOW_WRITE_OPERATIONS": "${TESTRAIL_ALLOW_WRITE_OPERATIONS}",
"TESTRAIL_ALLOW_READ_OPERATIONS": "${TESTRAIL_ALLOW_READ_OPERATIONS}",
"TESTRAIL_ALLOW_DELETE_OPERATIONS": "${TESTRAIL_ALLOW_DELETE_OPERATIONS}",
"TESTRAIL_ENABLE_DEPRECATED_TOOLS": "${TESTRAIL_ENABLE_DEPRECATED_TOOLS}",
"TESTRAIL_DISABLED_TOOLS": "${TESTRAIL_DISABLED_TOOLS}",
"TESTRAIL_REQUEST_TIMEOUT_MS": "${TESTRAIL_REQUEST_TIMEOUT_MS}"
}
}
}
}
#!/usr/bin/env bash
# Registers every server with Claude Code (run once; `claude mcp list` to check).
set -euo pipefail
set -a; [ -f .env ] && source .env; set +a
claude mcp add testrail -e "TESTRAIL_INSTANCE_URL=${TESTRAIL_INSTANCE_URL}" -e "TESTRAIL_USERNAME=${TESTRAIL_USERNAME}" -e "TESTRAIL_API_KEY=${TESTRAIL_API_KEY}" -e "TESTRAIL_ENABLE_SHARED_STEPS=${TESTRAIL_ENABLE_SHARED_STEPS}" -e "TESTRAIL_ENABLE_CASE_HISTORY=${TESTRAIL_ENABLE_CASE_HISTORY}" -e "TESTRAIL_ENABLE_RAG_TOOLS=${TESTRAIL_ENABLE_RAG_TOOLS}" -e "TESTRAIL_ALLOW_WRITE_OPERATIONS=${TESTRAIL_ALLOW_WRITE_OPERATIONS}" -e "TESTRAIL_ALLOW_READ_OPERATIONS=${TESTRAIL_ALLOW_READ_OPERATIONS}" -e "TESTRAIL_ALLOW_DELETE_OPERATIONS=${TESTRAIL_ALLOW_DELETE_OPERATIONS}" -e "TESTRAIL_ENABLE_DEPRECATED_TOOLS=${TESTRAIL_ENABLE_DEPRECATED_TOOLS}" -e "TESTRAIL_DISABLED_TOOLS=${TESTRAIL_DISABLED_TOOLS}" -e "TESTRAIL_REQUEST_TIMEOUT_MS=${TESTRAIL_REQUEST_TIMEOUT_MS}" -- npx -y @uarlouski/[email protected]
{
"mcpServers": {
"testrail": {
"command": "npx",
"args": [
"-y",
"@uarlouski/[email protected]"
],
"env": {
"TESTRAIL_INSTANCE_URL": "${TESTRAIL_INSTANCE_URL}",
"TESTRAIL_USERNAME": "${TESTRAIL_USERNAME}",
"TESTRAIL_API_KEY": "${TESTRAIL_API_KEY}",
"TESTRAIL_ENABLE_SHARED_STEPS": "${TESTRAIL_ENABLE_SHARED_STEPS}",
"TESTRAIL_ENABLE_CASE_HISTORY": "${TESTRAIL_ENABLE_CASE_HISTORY}",
"TESTRAIL_ENABLE_RAG_TOOLS": "${TESTRAIL_ENABLE_RAG_TOOLS}",
"TESTRAIL_ALLOW_WRITE_OPERATIONS": "${TESTRAIL_ALLOW_WRITE_OPERATIONS}",
"TESTRAIL_ALLOW_READ_OPERATIONS": "${TESTRAIL_ALLOW_READ_OPERATIONS}",
"TESTRAIL_ALLOW_DELETE_OPERATIONS": "${TESTRAIL_ALLOW_DELETE_OPERATIONS}",
"TESTRAIL_ENABLE_DEPRECATED_TOOLS": "${TESTRAIL_ENABLE_DEPRECATED_TOOLS}",
"TESTRAIL_DISABLED_TOOLS": "${TESTRAIL_DISABLED_TOOLS}",
"TESTRAIL_REQUEST_TIMEOUT_MS": "${TESTRAIL_REQUEST_TIMEOUT_MS}"
}
}
}
}
{
"servers": {
"testrail": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@uarlouski/[email protected]"
],
"env": {
"TESTRAIL_INSTANCE_URL": "${TESTRAIL_INSTANCE_URL}",
"TESTRAIL_USERNAME": "${TESTRAIL_USERNAME}",
"TESTRAIL_API_KEY": "${TESTRAIL_API_KEY}",
"TESTRAIL_ENABLE_SHARED_STEPS": "${TESTRAIL_ENABLE_SHARED_STEPS}",
"TESTRAIL_ENABLE_CASE_HISTORY": "${TESTRAIL_ENABLE_CASE_HISTORY}",
"TESTRAIL_ENABLE_RAG_TOOLS": "${TESTRAIL_ENABLE_RAG_TOOLS}",
"TESTRAIL_ALLOW_WRITE_OPERATIONS": "${TESTRAIL_ALLOW_WRITE_OPERATIONS}",
"TESTRAIL_ALLOW_READ_OPERATIONS": "${TESTRAIL_ALLOW_READ_OPERATIONS}",
"TESTRAIL_ALLOW_DELETE_OPERATIONS": "${TESTRAIL_ALLOW_DELETE_OPERATIONS}",
"TESTRAIL_ENABLE_DEPRECATED_TOOLS": "${TESTRAIL_ENABLE_DEPRECATED_TOOLS}",
"TESTRAIL_DISABLED_TOOLS": "${TESTRAIL_DISABLED_TOOLS}",
"TESTRAIL_REQUEST_TIMEOUT_MS": "${TESTRAIL_REQUEST_TIMEOUT_MS}"
}
}
}
}
name: my-agent target: local servers: - hub: io.github.uarlouski/testrail-mcp-server
- not probed yet: tools unpinned, ingest lists them