Magnet MCP Server
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Magnet MCP Serverlist my recent workflows"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Magnet MCP Server
An MCP server for interacting with Magnet (magnet.run)
Note: Currently macOS only. Windows and Linux support coming soon.
Setup
To set it up:
Generate an API key for your Workspace (Organization) at https://www.magnet.run/settings or from the Settings -> MCP section of the Desktop app.
Set up your MCP server configuration:
For Cursor or Claude Desktop (add to your MCP settings JSON):
{
"Magnet": {
"command": "npx",
"args": [
"-y",
"@magnet-ai/magnet-mcp-server"
],
"env": {
"MAGNET_API_KEY": "your-api-key-here"
}
}
}For Claude Code (run this command):
claude mcp add --transport stdio Magnet --env MAGNET_API_KEY=your-api-key-here -- npx -y @magnet-ai/magnet-mcp-server💡 TIP:
If you are seeing issues getting your MCP server configuration working, consider that it might be an issue with the node / npx version, and try to put a full path to the npx you would like to use in the "command" field.
Related MCP server: Obsidian Claude Code MCP Server
Local Development
For instructions on developing and testing locally, see LOCAL_DEVELOPMENT.md.
Available Tools
10 toolscreate_issueCreate IssueB
Create a new issue in Magnet using markdown content. Supports standard markdown syntax including headings, lists, code blocks, links, etc.
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | Title of the issue. If not provided, will be auto-generated from the description. | |
| status | No | Status of the issue | |
| markdown | Yes | Markdown content for the issue body. Supports standard markdown syntax including headings, lists, code blocks, links, etc. | |
| baseBranch | Yes | Git-safe branch name for the base branch (e.g., 'main', 'canary') | |
| properties | No | Optional issue properties | |
| description | Yes | Description of the issue. Used for title generation if title is not provided. | |
| organizationId | No | ID of the organization. Optional when using API key authentication. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It only states the tool creates an issue and supports markdown, but does not disclose behavioral traits such as authentication requirements, success/error behavior, or side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise with two sentences. The first sentence states the purpose and the second adds relevant detail about markdown syntax. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With 7 parameters, 3 required, no output schema, and no annotations, the description is too minimal. It does not cover important context like required parameters, auto-generation of title, or behavior of optional fields like organizationId.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description adds a mention of markdown support but largely repeats what is already in the schema, offering no significant additional meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it creates a new issue in Magnet using markdown content, which is a specific verb and resource. It distinguishes from sibling tools like get_issue_by_id and update_issue.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like update_issue or list_issues. It lacks any when-to-use or when-not-to-use context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
create_pageCreate PageB
Create a new page in Magnet using markdown content. Supports standard markdown syntax including headings, lists, code blocks, links, etc.
Page types:
'note' (default): A general note or document
'sprint_planning': A sprint planning document
'context_doc_label': A context documentation page
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | Title of the page | |
| markdown | Yes | Markdown content for the page body | |
| pageType | No | Type of page. Defaults to 'note'. | |
| properties | No | Optional page properties (type-specific) | |
| organizationId | No | ID of the organization. Optional when using API key authentication. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It discloses supported markdown syntax and page types, but lacks details on destructiveness (creating is non-destructive), required permissions, error handling, or behavior on duplicate titles.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, with the main purpose front-loaded. It uses three short paragraphs, each with a clear focus (main action, supported syntax, page types). No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 5 parameters, no output schema, and nested objects, the description lacks details on return values, expected properties for page types, and behavioral traits like permissions or errors. It is insufficient for an agent to fully understand the tool's context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds context about markdown syntax and page type defaults beyond the schema enum, but does not elaborate on the 'properties' parameter's type-specific usage, leaving some ambiguity.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool creates a page using markdown content, specifying the resource ('page') and action ('create'). It lists page types, distinguishing it from sibling tools like create_issue, and provides concrete examples.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is given on when to use this tool versus siblings like create_issue or update_page. There is no mention of prerequisites, when not to use it, or alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_issue_by_idGet Issue by IDA
Fetch a single issue by its ID from Magnet and return it as markdown. The issue includes a 'baseBranch' field which indicates the target branch for any pull requests related to this issue. Use previewOnly=true to get a markdown preview (first 100 words) instead of full content.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The issue ID | |
| previewOnly | No | If true, returns markdown preview (first 100 words) instead of full markdown |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, description carries full burden. It reveals output format (markdown), baseBranch field, and preview behavior. Lacks details on error handling, auth requirements, or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two lean sentences: first states core action, second adds preview option. No fluff, front-loaded key info.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Adequate for a simple fetch tool with no output schema. Covers parameters and output format. Could mention response structure or error cases but overall sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. Description reinforces previewOnly semantics and adds context about baseBranch field, but id parameter is not enriched beyond minimal schema description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states it fetches a single issue by ID and returns markdown. Distinguishes from sibling tools like list_issues (batch) and create/update (mutations).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit guidance on using previewOnly for truncated output. Does not explicitly state when not to use, but the context with siblings makes it clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_page_by_idGet Page by IDA
Fetch a single page by its ID from Magnet and return it as markdown. Use previewOnly=true to get a markdown preview instead of full content.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The page ID | |
| previewOnly | No | If true, returns markdown preview instead of full markdown |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description carries full burden. It discloses basic read behavior and markdown output, but does not mention error handling (e.g., missing ID), permissions, or idempotency. Minimal behavioral context beyond purpose.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the core action, and no wasted words. Every sentence adds value: the first states the main purpose, the second explains the key parameter variant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple fetch tool with 2 parameters and no output schema or annotations, the description covers the essential purpose and parameter nuance. It could mention error behavior or return format details, but is mostly complete given the tool's simplicity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds value beyond the schema by explaining that previewOnly=true returns a markdown preview instead of full content. The id parameter is straightforward and needs no further clarification. With 100% schema coverage, the description meaningfully enhances parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Fetch', resource 'page by ID', and output format 'return as markdown'. It distinguishes from siblings like get_issue_by_id and list_pages by specifying the unique resource and action.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when you have a specific page ID, but does not explicitly state when to use this vs alternatives like list_pages or search. No exclusions or alternative recommendations are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_issuesList IssuesA
List all issues for your organization in Magnet with markdown content. The organization is determined automatically from your API key. Each issue includes a 'baseBranch' field which indicates the target branch for any pull requests related to that issue. Use previewOnly=true to get markdown previews (first 100 words) instead of full content. Supports cursor-based pagination with limit (1-100, default 50) and cursor parameters. Response includes pagination metadata with total count, hasMore flag, and nextCursor for fetching subsequent pages.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of issues to return (1-100). Defaults to 50. | |
| cursor | No | Cursor for pagination. Use nextCursor from previous response to get next page. | |
| previewOnly | No | If true, returns markdown previews instead of full markdown | |
| organizationId | No | ID of the organization. Optional when using API key authentication. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden. It discloses pagination behavior (cursor-based, limit, hasMore, nextCursor), previewOnly returning first 100 words, and the inclusion of baseBranch field. It does not explicitly state read-only nature, but listing implies non-destructive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise at 6 sentences, front-loaded with core purpose, then details. No redundant information; every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description explains return fields (baseBranch) and pagination metadata. It covers preview behavior and organization detection. Could mention sorting but not essential for a list tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so parameters are documented. The description adds meaning beyond schema: context about automatic organization detection, preview length, and pagination metadata. It provides useful elaboration.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it lists issues for an organization in Magnet with markdown content, using a specific verb and resource. It distinguishes from siblings like get_issue_by_id (single issue) and create_issue by focusing on listing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains organization detection and previewOnly usage but does not explicitly provide when to use this tool versus alternatives. Sibling tools are listed, but no guidance on selection criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_pagesList PagesA
List all pages for your organization in Magnet with markdown content. The organization is determined automatically from your API key. Use previewOnly=true to get markdown previews instead of full content. Supports cursor-based pagination with limit (1-100, default 50) and cursor parameters. Response includes pagination metadata with total count, hasMore flag, and nextCursor for fetching subsequent pages.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of pages to return (1-100). Defaults to 50. | |
| cursor | No | Cursor for pagination. Use nextCursor from previous response to get next page. | |
| previewOnly | No | If true, returns markdown previews instead of full markdown | |
| organizationId | No | ID of the organization. Optional when using API key authentication. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Despite no annotations, the description explains pagination behavior (cursor-based, limit, nextCursor), preview behavior, and auto-detection of organization. It lacks explicit statement of read-only nature but implies it via listing semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured with the main verb-resource phrase first, followed by three informative sentences. It avoids redundancy but each sentence adds necessary detail.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description covers key response metadata (total count, hasMore, nextCursor) and distinguishes between full content and previews. It could mention the page object shape but is sufficient for a list endpoint.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the description adds contextual value by explaining the auto-detection of organization, the effect of previewOnly, and pagination details. This enriches the schema definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it lists all pages for the organization in Magnet with markdown content, specifying the previewOnly option. It distinguishes itself from siblings like get_page_by_id and create_page by focusing on bulk listing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context on when to use the tool, mentioning automatic organization determination, previewOnly mode, and pagination. However, it does not explicitly contrast with search or list_issues for filtering needs.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
searchSearchA
Search for issues and pages in Magnet. Searches across document properties including title and content.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Search term to match against document properties | |
| types | No | Resource types to search. Defaults to both ['issue', 'page']. | |
| organizationId | No | Organization ID. Optional when using API key authentication. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description carries the burden. It only mentions searching across title and content, but lacks details on pagination, result format, query behavior (exact/fuzzy), or limits. Minimal disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no waste. Every word adds value and the structure is front-loaded with the core action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema and simple schema, the description covers the basics of what is searched. Missing return format but acceptable for a straightforward search tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with all parameters described. The description does not add additional parameter-specific value beyond the schema, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches for issues and pages across title and content, using a specific verb and resource. It distinguishes from sibling tools like get_issue_by_id or list_issues, which are CRUD-specific.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when a query-based search is needed, but does not explicitly state when not to use or provide alternatives. Since the context makes it fairly intuitive, it scores a 4.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_issueUpdate IssueA
Update an existing issue in Magnet using markdown content. Only provided fields will be updated. Supports standard markdown syntax including headings, lists, code blocks, links, etc.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ID of the issue to update | |
| title | No | New title for the issue | |
| status | No | New status for the issue | |
| markdown | Yes | New markdown content for the issue body | |
| assigneeClerkId | No | Clerk user ID of the assignee |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry full burden. It discloses partial update behavior but omits critical details such as error handling (missing issue), authorization requirements, rate limits, or side effects. For a mutation tool, this is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, 33 words, with no redundancy. The key action is front-loaded. Every sentence adds value without fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers main points (update, partial update, markdown) but lacks explanation of return values or error scenarios. Given no output schema, the description should hint at what the tool returns. It's adequate but not thorough.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with good descriptions for each parameter. The description adds little beyond the schema; it mentions markdown content but doesn't enhance parameter semantics. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Update' and the resource 'existing issue in Magnet'. It distinguishes from siblings like create_issue and get_issue_by_id by focusing on updating an existing issue. The mention of 'using markdown content' adds specificity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use (to modify an existing issue) but does not explicitly state when not to use or provide alternatives. The phrase 'Only provided fields will be updated' gives partial guidance but lacks exclusions or comparisons with sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_pageUpdate PageA
Update an existing page in Magnet using markdown content. Only provided fields will be updated. Supports standard markdown syntax including headings, lists, code blocks, links, etc.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ID of the page to update | |
| title | No | New title for the page | |
| markdown | Yes | New markdown content for the page body | |
| properties | No | New page properties (type-specific) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description discloses key behaviors: partial update (only provided fields change) and markdown syntax support. However, it omits return format, required permissions, or any side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences front-load the action and key detail. Every sentence contributes useful information without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 4-param tool with no output schema, the description adequately covers the update operation, partial update, and markdown support. Lacks mention of return value or error conditions, but is otherwise complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with clear descriptions. The description adds value by clarifying that markdown parameter accepts standard syntax and that only provided fields are affected, supplementing schema detail.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'update' and the resource 'existing page in Magnet', specifying markdown content and partial update behavior. It distinguishes from sibling tools like create_page and list_pages by focusing on modification.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for updating existing pages but lacks explicit guidance on when to use this tool versus alternatives like get_page_by_id or create_page. No exclusions or prerequisites are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
upload_chatUpload ChatA
Upload a chat session to Magnet for tracking and analysis. Returns the created chat with a viewUrl to see it in the web UI.
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | Optional title override. Auto-generated from first message if not provided. | |
| filePath | Yes | Path to JSON file containing the full chat export (source, sessionId, projectPath, gitBranch, rawPayload) | |
| organizationId | No | Organization ID. Optional when using API key authentication. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must disclose behavior. It reveals that a chat is created and a viewUrl is returned, but does not mention authentication needs, error handling for invalid filePath, or any constraints. Adequate but not thorough.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Extremely concise: two sentences with no wasted words. The purpose and key return value are front-loaded, making it easy to scan.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple creation tool with 3 parameters and no output schema, the description covers purpose, return value with viewUrl, and parameter details via schema. It could mention error cases, but is largely complete for the complexity level.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with inline descriptions for all 3 parameters. The tool description adds no additional parameter context beyond what the schema already provides, meeting the baseline but not exceeding it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description explicitly states the verb (Upload), resource (chat session), and purpose (tracking and analysis), clearly distinguishing it from sibling tools focused on issues, pages, and search.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the tool is for uploading chat sessions but provides no explicit guidance on when to use it versus alternatives or when not to use it. Siblings are different enough to avoid confusion, but lacks exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
10 tool updates
v0.5.0- First observed
create_issue - First observed
create_page - First observed
get_issue_by_id - First observed
get_page_by_id - First observed
list_issues - First observed
list_pages - First observed
search - First observed
update_issue - First observed
update_page - First observed
upload_chat
TDQS
Scored across 10 tools
Each tool targets a distinct combination of resource (issue, page, chat) and action (get, list, create, update, upload, search). There is no ambiguity between tools, as issues and pages are clearly separate entities.
All tool names follow a consistent verb_noun pattern using snake_case (e.g., get_issue_by_id, list_issues, create_page, update_page, upload_chat, search). This consistency aids in predictable tool selection.
With 10 tools covering CRUD operations for two resources plus additional upload and search capabilities, the count is well-scoped for a documentation/issue tracking server.
The tool set covers create, read, update, and list operations for both issues and pages, along with search and chat upload. The only notable gap is the absence of delete operations for issues and pages, which may be intentional but leaves a minor incompleteness.
Maintenance
Related MCP Connectors
Shared memory and actions for Claude, Kiro, OpenAI, Cursor, and other MCP-compatible AI clients.
MCP-native notes and memory for ChatGPT, Claude, and other AI tools.
Persistent AI memory shared across Claude, ChatGPT, coding agents, and compatible MCP clients.
Persistent memory for Claude Code and Cursor. Stop re-explaining your project every session.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceMCP of MCPs. Automatic discovery and configure MCP servers on your local machine. Integration with Claude and Cursor.52Apache 2.0
- AlicenseNot gradedqualityDmaintenanceEnables Claude Code and Claude Desktop to interact with Obsidian vaults through MCP protocol. Supports file operations, workspace context access, and dual transport (WebSocket and HTTP/SSE) for AI-powered assistance with your notes.352BSD Zero Clause
- AlicenseAqualityCmaintenanceOfficial MCP (Model Context Protocol) server for Iron.xyz API, designed to work with Claude Desktop, Cursor IDE and other MCP compatible clients.321 npm2MIT
- AlicenseAqualityDmaintenanceGives Claude Code, Claude Desktop, Cursor, VS Code Copilot, and other MCP-compatible tools persistent memory.1844 npm1MIT