Skip to main content

MCP (Model Context Protocol)

The Model Context Protocol (MCP) provides a standardized interface for AI clients - such as Claude Desktop, Cursor, or custom agents - to interact with the Clears AI platform. Through MCP, external tools can search tasks, manage issues, read pull requests, and more, all using a consistent protocol.

Server Configuration

Endpoint

https://{host}/api/v1/mcp/

Replace {host} with your Clears AI instance hostname (e.g., api.clears.ai).

Authentication

MCP supports three authentication methods depending on the client type:

MethodUse CaseFormat
HMAC-SHA256Internal service-to-service callsSigned request headers
Personal Access Token (PAT)CLI tools and external AI clientsBearer token with cl_pat_ prefix
Cognito JWTWeb application sessionsStandard JWT bearer token

Personal Access Token

PATs are the recommended method for connecting external AI clients. Generate a token from Settings > API Keys - tokens use the cl_pat_ prefix.

Example configuration for Claude Desktop (claude_desktop_config.json):

{
"mcpServers": {
"clears": {
"url": "https://api.clears.ai/api/v1/mcp/",
"headers": {
"Authorization": "Bearer cl_pat_your_token_here"
}
}
}
}

Available Tools

MCP exposes 23 tools organized across six categories. Each tool includes annotation hints (readOnlyHint, destructiveHint, idempotentHint) so AI clients can make informed decisions about tool usage.

Board Tools

Tools for managing stories and interacting with the AI workflow.

ToolDescriptionRead-Only
search_tasksSearch for stories and tasks by keyword, status, or assigneeYes
perform_actionExecute a workflow action on a story (e.g., approve, start implementation)No
get_qa_sessionRetrieve the Q&A session for a story in analysisYes
submit_qa_answersSubmit answers to the AI's clarifying questionsNo
discover_actionsList available actions for a story in its current stateYes
run_taskTrigger a workflow run on a specific taskNo

Issue Tools

Tools for reading and updating Jira issues linked to Clears AI.

ToolDescriptionRead-Only
get_issueRetrieve full details of an issue by keyYes
update_issue_descriptionUpdate an issue's description fieldNo
update_issue_summaryUpdate an issue's summary/titleNo
update_issue_assigneeChange the assignee of an issueNo
update_issue_reporterChange the reporter of an issueNo
add_commentAdd a comment to an issueNo

Pull Request Tools

Tools for reviewing pull requests and listing repositories.

ToolDescriptionRead-Only
read_prRead the full details of a pull request including diff and commentsYes
comment_on_prAdd a review comment to a pull requestNo
list_reposList all repositories connected to the workspaceYes

Session Tools

Tools for interacting with AI execution sessions.

ToolDescriptionRead-Only
read_ai_sessionRead the log and state of an AI sessionYes
write_ai_sessionWrite data or instructions to an active AI sessionNo
get_run_statusCheck the current status of a workflow runYes

Knowledge Tools

Tools for searching the platform's knowledge base and user stories.

ToolDescriptionRead-Only
search_knowledgeSearch the AI's accumulated knowledge documentsYes
search_user_storiesSearch across all user stories by keyword or filterYes

Utility Tools

General-purpose tools for connectivity and session management.

ToolDescriptionRead-Only
pingTest connectivity to the MCP serverYes
search_sessionsSearch across AI sessions by keyword or statusYes
memory_searchSearch the AI's memory for relevant contextYes

Tool Annotations

Each tool carries annotation hints that help AI clients decide how to use it:

{
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true
}
}
AnnotationMeaning
readOnlyHintThe tool only reads data and does not modify state
destructiveHintThe tool may delete or irreversibly modify data
idempotentHintCalling the tool multiple times with the same input produces the same result

AI clients can use these hints to, for example, auto-approve read-only tools while requiring confirmation for destructive ones.

Connecting External MCP Servers

Clears AI can also act as an MCP client, connecting to external MCP servers to give its AI agents additional capabilities. Configure external servers in Settings > AI Agent Tools.

For example, connecting a CloudWatch MCP server gives the AI agent access to log analysis and metric monitoring during implementation.