MCP Server Setup Guide
ISO Mate’s MCP (Model Context Protocol) server lets AI assistants and IDE tools manage your entire platform directly. With 15 tool providers covering DevOps, QA, tasks, incidents, compliance, help desk, notes, custom objects, workflows, reports, editor AI, contacts, and billing, you can operate ISO Mate without leaving your development environment.
Step 1: Create an API Token
- Navigate to Profile > API Tokens in the top nav bar.
- Click Create Token.
- Give the token a descriptive name (e.g., “IDE MCP Token”).
- Select the scopes your tool needs. Scopes are organized by module:
- issue.*, sprint.*, release.*, userstory.*, feature.* for DevOps
- testcase.*, testcycle.*, testenvironment.* for QA
- task.*, recurringtask.* for Task Management
- incident.* for Incidents
- compliance.* for Compliance (frameworks, requirements, controls, policies, procedures, evidence, attestations)
- compliance_ai.search, compliance_ai.generate for the Compliance AI tools (search, generate template, complete section)
- ticket.*, cannedresponse.* for Help Desk
- note.*, notefolder.*, notetag.* for Notes
- objecttype.*, entry.* for Custom Objects
- workflow.* for Workflows (including metrics, templates, versions, and import/export)
- compliance.reports, sales.reports, feedback.reports, calendar.reports for the Reporting tools
- editor_ai.assist for the Editor AI tools
- contact.* for Contacts
- billing.view for Billing (read-only, excluded from token scopes by default)
- Click Save and copy the token. It will not be shown again.
Step 2: Configure Your MCP Client
Add the ISO Mate MCP server to your client’s configuration. The exact format depends on your tool, but you will need:
- Server URL: Your ISO Mate MCP API endpoint
- API Token: The token you created in Step 1
Available Tool Providers
Once connected, the following 15 tool providers are available. Each provider uses a resource/operation pattern (e.g., resource: “issues”, operation: “create”).
1. DevOps
Manage your agile workflow: issues (list, get, create, update, delete, add/list comments), sprints (CRUD, start, close), releases (CRUD, release, archive), user stories (CRUD), and features (CRUD).
2. Quality Assurance
Run your QA process: test cases (CRUD with folder, priority, and type filters), test cycles (CRUD, close), test executions (list, get, start, complete, block with reason), and test environments (CRUD).
3. Task Management
Manage work items: tasks (CRUD, toggle complete) with priority, due dates, and assignees. Recurring tasks (CRUD) with daily, weekly, monthly, yearly, or custom recurrence patterns.
4. Incident Management
Track incidents through their lifecycle: CRUD operations, status transitions (Open, Investigating, Contained, Resolved, Closed), user assignment with roles, task and note linking, and audit log viewing.
5. Compliance
Manage your compliance program: frameworks (CRUD, archive), requirements (CRUD with status tracking), controls (CRUD, map to requirements/policies, link procedures), policies (CRUD, publish, version, assign for attestation), procedures (CRUD, publish, version, toggle active), evidence (list, get, update, delete, link to controls), attestations (list, progress), and Compliance AI (search published policies and procedures, generate templates, complete sections).
6. Help Desk
Handle support: tickets (CRUD, add replies/notes, list replies, merge, manage watchers, link entities, manage tags) and canned responses (CRUD, list categories).
7. Notes
Organize documentation: notes (CRUD, move between folders), note folders (CRUD for hierarchical organization), and note tags (CRUD for categorization).
8. Custom Objects
Work with custom data: object types (CRUD for schema definitions) and entries (CRUD with automatic schema validation).
9. Workflow Automation
Build and govern automations: workflows (CRUD, toggle, bulk enable/disable/delete, rotate webhook secret, dry-run, manual run discovery and dispatch, audits), executions (list, get, stats, retry), metrics (per-workflow and account overview), templates (browse the gallery, instantiate), versions (history, restore), import and export (portable JSON), and configuration discovery (trigger entities, events, sources, action types, field schemas, relation allow lists, object types, mailboxes, forms, and placeholder validation).
10. Reports
Pull chart-ready report data that mirrors the console report pages. Compliance reports (distribution and trends), sales reports (distribution and trends), feedback reports (distribution and trends), and calendar reports (distribution and trends). Each accepts date range filters, and trends accept a grouping interval of day, week, month, or year. Each report requires its matching reports permission.
11. Editor AI
Generate and refine rich-text content for supported editor contexts such as policies, procedures, issues, notes, tickets, and emails.
12. Contacts
Manage your contact directory: full CRUD with search by email, name, or company.
13. Billing (Read-Only)
View subscription status, plan details, trial info, and invoice history. Billing management scopes are excluded from API tokens by design for security.
Legacy Issue Tools
Standalone issue tools (list_issues, get_issue, create_issue, update_issue, delete_issue, add_issue_comment, list_issue_comments) are also available for backward compatibility with older MCP clients.
Using Project Keys
You can reference issues by their project key instead of UUID. For example, pass BUG-7 to the get operation to retrieve that bug directly. Use the project_key filter to find all issues with a given prefix.
Security Notes
- Each token is scoped to a single account. Data from other accounts is never accessible.
- Grant only the scopes your tool needs (principle of least privilege).
- Billing management scopes are excluded from API tokens by design.
- Revoke tokens immediately if they are compromised.