MCP Tools Reference

Detailed parameter documentation for all 46 MCP tools.

Issue Tracking

list_issues

List issues in the workspace with optional filters.

ParameterTypeRequiredDescription
projectIdstringNoFilter by project ID
statusIdstringNoFilter by status ID
prioritystringNoFilter by priority: URGENT, HIGH, MEDIUM, LOW, NONE
assigneeIdstringNoFilter by assignee user ID
labelIdstringNoFilter by label ID
limitnumberNoMax results (default 50, max 50)
offsetnumberNoOffset for pagination

get_issue

Get full details of a specific issue including labels.

ParameterTypeRequiredDescription
issueIdstringYesIssue UUID or identifier (e.g., "ENG-123")

create_issue

Create a new issue in the workspace. Requires mcp:write scope.

ParameterTypeRequiredDescription
titlestringYesIssue title
descriptionstringNoIssue description (plain text, Markdown, or HTML). Markdown is automatically rendered as rich text in the UI.
teamIdstringYesTeam ID to create the issue in
projectIdstringNoProject ID to assign to
prioritystringNoPriority: URGENT, HIGH, MEDIUM, LOW, NONE
statusIdstringNoStatus ID (defaults to team's default status)
assigneeIdstringNoUser ID to assign
labelIdsstring[]NoLabel IDs to attach

update_issue

Update an existing issue. Only provided fields are changed. Requires mcp:write scope.

ParameterTypeRequiredDescription
issueIdstringYesIssue UUID to update
titlestringNoNew title
descriptionstringNoNew description (plain text, Markdown, or HTML). Markdown is automatically rendered as rich text in the UI.
prioritystringNoNew priority
statusIdstringNoNew status ID
assigneeIdstringNoNew assignee (null to unassign)

search_issues

Full-text search across issue titles, descriptions, and identifiers.

ParameterTypeRequiredDescription
querystringYesSearch query string
limitnumberNoMax results (default 20, max 50)

add_comment

Add a comment to an issue. Requires mcp:write scope.

ParameterTypeRequiredDescription
issueIdstringYesIssue UUID to comment on
bodystringYesComment text (plain text or markdown)
parentIdstringNoParent comment ID for threaded replies

list_comments

List all comments on an issue, ordered by creation date.

ParameterTypeRequiredDescription
issueIdstringYesIssue UUID

Projects & Cycles

list_projects

List all projects in the workspace with optional status filter.

ParameterTypeRequiredDescription
statusstringNoFilter by status: BACKLOG, PLANNED, IN_PROGRESS, COMPLETED, CANCELLED

get_project

Get detailed information about a project including milestones and issue count.

ParameterTypeRequiredDescription
projectIdstringYesProject UUID

list_cycles

List sprint cycles for teams in the workspace.

ParameterTypeRequiredDescription
statusstringNoFilter by status: UPCOMING, ACTIVE, COMPLETED

get_cycle

Get a single cycle with issue counts and completion progress.

ParameterTypeRequiredDescription
idstringYesCycle UUID

Workspace Metadata

list_teams, list_labels, list_statuses, list_members

These tools list workspace metadata. They take no parameters and return arrays of the respective entities with their IDs and names. Use these to resolve IDs before calling other tools.

Roadmap

list_roadmap_items

List roadmap items in the workspace with optional filters.

ParameterTypeRequiredDescription
statusstringNoFilter by status: PLANNED, IN_PROGRESS, COMPLETED, CANCELLED
categorystringNoFilter by category: FEATURE, IMPROVEMENT, BUG, INFRASTRUCTURE
versionIdstringNoFilter by roadmap version ID
limitnumberNoMax results (default 50, max 100)

create_roadmap_item

Create a new roadmap item. Requires mcp:write scope.

ParameterTypeRequiredDescription
titlestringYesItem title
descriptionstringNoItem description
statusstringNoStatus: PLANNED (default), IN_PROGRESS, COMPLETED, CANCELLED
categorystringNoCategory: FEATURE (default), IMPROVEMENT, BUG, INFRASTRUCTURE
versionIdstringNoAssign to a roadmap version
assigneeIdstringNoAssign to a user
isPublicstringNoWhether publicly visible ("true"/"false", default "true")

update_roadmap_item

Update an existing roadmap item. Only provided fields are changed. Requires mcp:write scope.

ParameterTypeRequiredDescription
idstringYesRoadmap item UUID
titlestringNoNew title
descriptionstringNoNew description
statusstringNoNew status
categorystringNoNew category
versionIdstringNoNew version ID (null to unassign)
assigneeIdstringNoNew assignee (null to unassign)
isPublicstringNoWhether publicly visible

delete_roadmap_item

Delete a roadmap item. Requires mcp:write scope.

ParameterTypeRequiredDescription
idstringYesRoadmap item UUID

vote_roadmap_item

Toggle vote on a roadmap item. Votes if not yet voted, unvotes if already voted. Requires mcp:write scope.

ParameterTypeRequiredDescription
idstringYesRoadmap item UUID

list_roadmap_versions

List all roadmap versions (release milestones) with item counts. No parameters required.

create_roadmap_version

Create a new roadmap version. Requires mcp:write scope.

ParameterTypeRequiredDescription
namestringYesVersion name (e.g., "v2.0")
descriptionstringNoVersion description
targetDatestringNoTarget release date (ISO 8601)

get_roadmap_settings

Get the roadmap settings for the workspace. No parameters required.

Returns: isPublicEnabled, allowSubmissions, allowVoting.

update_roadmap_settings

Update roadmap settings. Requires mcp:write scope.

ParameterTypeRequiredDescription
isPublicEnabledstringNoEnable public roadmap ("true"/"false")
allowSubmissionsstringNoAllow public submissions ("true"/"false")
allowVotingstringNoAllow voting ("true"/"false")

Workspace & User

list_workspaces

List all workspaces the authenticated user belongs to. No parameters required.

Returns an array of workspaces with: id, name, slug, description, logoUrl, role, createdAt.

create_workspace

Create a new workspace. The authenticated user becomes the owner. Requires mcp:write scope.

ParameterTypeRequiredDescription
namestringYesWorkspace display name
slugstringYesURL-friendly slug (lowercase, hyphens, no spaces)
logoUrlstringNoLogo URL for the workspace

delete_workspace

Permanently delete a workspace and all its data. Only the workspace owner can perform this action. This cannot be undone. Requires mcp:write scope.

ParameterTypeRequiredDescription
idstringYesWorkspace UUID to delete

get_workspace

Get details about the current workspace including name, slug, plan, and member/team counts. No parameters required.

update_workspace

Update the current workspace settings. Requires mcp:write scope.

ParameterTypeRequiredDescription
namestringNoNew workspace name
descriptionstringNoNew workspace description

get_current_user

Get the profile of the currently authenticated user. No parameters required.

Returns: id, email, displayName, avatarUrl, createdAt.

update_current_user

Update the current user's profile. Requires mcp:write scope.

ParameterTypeRequiredDescription
displayNamestringNoNew display name
avatarUrlstringNoNew avatar URL

list_user_api_keys

List all personal API keys (velu_ prefix) for the current user. No parameters required.

Returns an array of keys with: id, name, keyPrefix, scopes, lastUsedAt, createdAt.

create_user_api_key

Create a personal API key for the current user. The full key is returned once and cannot be retrieved again. Requires mcp:write scope.

ParameterTypeRequiredDescription
namestringYesName for the key (e.g., "CLI Tool")
scopesstring[]YesScopes to grant (e.g., user:read, workspaces:list)

revoke_user_api_key

Revoke a personal API key. This immediately invalidates the key. Requires mcp:write scope.

ParameterTypeRequiredDescription
idstringYesUser API key UUID to revoke

Custom Domains

list_domains

List all custom domains configured for the workspace. No parameters required.

Returns domain name, status (PENDING, VERIFIED, FAILED), CNAME target, and verification details.

add_domain

Add a custom domain. Returns DNS records needed for setup. Requires mcp:write scope.

ParameterTypeRequiredDescription
domainstringYesThe domain to add (e.g., "issues.example.com")

Returns setup instructions with two DNS records: (1) a CNAME record pointing to custom.velocity.quest, and (2) a TXT record for domain ownership verification.

verify_domain

Check domain verification status and get setup instructions. Requires mcp:write scope.

ParameterTypeRequiredDescription
idstringYesDomain UUID to verify

remove_domain

Remove a custom domain from the workspace. Requires mcp:write scope.

ParameterTypeRequiredDescription
idstringYesDomain UUID to remove

Claude Agent

transition_issue

Move an issue to a new status by name instead of UUID. Resolves the status name within the issue's team. Requires mcp:write scope.

ParameterTypeRequiredDescription
issueIdstringYesIssue UUID or identifier (e.g., "ENG-123")
statusNamestringYesTarget status name (e.g., "In Progress", "Done")

get_my_issues

Get issues assigned to the authenticated user with optional status group filter.

ParameterTypeRequiredDescription
statusGroupstringNoFilter by status group: backlog, unstarted, started, completed, cancelled
limitnumberNoMax results (default 50)

get_active_sprint

Get the currently active sprint cycle with issue counts and completion progress. No parameters required.

Returns: cycle name, start/end dates, total issues, completed count, progress percentage, and issues breakdown by status.

link_commit

Record a commit SHA against an issue for traceability. Requires mcp:write scope.

ParameterTypeRequiredDescription
issueIdstringYesIssue UUID or identifier
commitShastringYesGit commit SHA
messagestringNoCommit message
urlstringNoURL to the commit

link_pr

Record a pull request against an issue. Requires mcp:write scope.

ParameterTypeRequiredDescription
issueIdstringYesIssue UUID or identifier
prUrlstringYesPull request URL
titlestringNoPR title
statusstringNoPR status: open, merged, closed

get_issue_context

Get rich context for an issue including comments, activity log, labels, and linked integration events.

ParameterTypeRequiredDescription
issueIdstringYesIssue UUID or identifier

get_pending_agent_runs

Get pending agent runs for the local_agent tier. Used by the local agent runner to poll for work. No parameters required.

Returns an array of pending runs with: id, trigger_type, trigger_entity_type, trigger_entity_id, metadata, created_at.

update_agent_run

Update an agent run's status, token counts, and result. Requires mcp:write scope.

ParameterTypeRequiredDescription
runIdstringYesAgent run UUID
statusstringNoNew status: running, completed, failed, cancelled
resultSummarystringNoSummary of the agent's output
errorMessagestringNoError message if failed
inputTokensnumberNoTotal input tokens used
outputTokensnumberNoTotal output tokens used
modelstringNoModel used for the run