apidog-tests-mcp
MCP (Model Context Protocol) server for managing Apidog test cases, scenarios, suites, and test data. Gives AI assistants full read/write access to Apidog's test management features.
This project is not an official Apidog integration.
Features
- Test Cases -- Create, read, update, delete, and bulk-create test cases for API endpoints
- Test Scenarios -- Build multi-step test flows chaining multiple API calls
- Test Suites -- Organize tests into runnable suites for CI/CD
- Test Data -- Manage data-driven test iterations with CSV-formatted data
- Folders -- Organize scenarios and suites into nested folder structures
- Read-only tools -- List environments, endpoints, categories, tags, runners, and coverage statistics
Documentation
docs/PRACTICAL-USAGE.md-- proven patterns for creating stable test cases/scenarios/suitesSECURITY.md-- vulnerability reporting and secure usage guidelinesCONTRIBUTING.md-- contribution workflowCHANGELOG.md-- release notes
Installation
npm install -g @acabala/apidog-tests-mcp
Or use directly with npx:
npx @acabala/apidog-tests-mcp
Configuration
The server requires these environment variables:
MCP Client Configuration
Add to your MCP client config (e.g. Claude Desktop claude_desktop_config.json):
{
"mcpServers": {
"apidog-tests": {
"command": "npx",
"args": ["@acabala/apidog-tests-mcp"],
"env": {
"APIDOG_ACCESS_TOKEN": "your-token",
"APIDOG_PROJECT_ID": "your-project-id",
"APIDOG_BRANCH_ID": "your-branch-id"
}
}
}
}
Recommended Token Practices
- Use a dedicated token for automation.
- Scope access to the minimum required Apidog project(s).
- Rotate tokens regularly.
- Keep MCP client config files local/private.
Available Tools
Read-only
Test Cases
Test Scenarios
Test Suites
Test Data
Folders
Development
# Install dependencies
npm install
# Run in development mode
npm run start:dev
# Type check
npm run typecheck
# Format
npm run format
# Run tests
npm test
# Run tests with coverage
npm run test:coverage
# Build for production
npm run build
Security
- Use a dedicated automation token with minimal required permissions.
- Never commit
APIDOG_ACCESS_TOKENor environment-specific IDs. - Keep local MCP client config files private.
- See
SECURITY.mdfor reporting and response policy.
Release and Versioning
This repository uses Changesets and a GitHub Actions release workflow:
- Add a changeset for user-visible changes:
npm run changeset - Release automation creates/updates a version PR on
main - Merged release PR publishes to npm with provenance
Open Source Guidelines
- Contribution guide:
CONTRIBUTING.md - Code of conduct:
CODE_OF_CONDUCT.md - Changelog:
CHANGELOG.md
Practical Tips
- Always include
pathandparameters.pathwhen creating route-parameterized test cases. - For update operations, prefer this server's merge-style tools over raw full-replace payloads.
- Use
customScriptpost-processors for assertions to avoid runner issues with declarative assertions. - See
docs/PRACTICAL-USAGE.mdfor complete examples.
Project Structure
src/
index.ts Entry point, registers tools and starts MCP server
client.ts ApidogClient HTTP wrapper with auth headers
types.ts Shared TypeScript interfaces and MCP result helpers
errors.ts Custom error classes (ApidogApiError, ApidogConfigError)
schemas.ts Shared Zod schemas for request parameters
tools/
read.ts Read-only tools (environments, endpoints, categories, etc.)
test-cases.ts Test case CRUD tools
test-scenarios.ts Test scenario CRUD tools
test-suites.ts Test suite CRUD tools
test-data.ts Test data CRUD tools
folders.ts Folder management tools