Skip to main content
Glama

Export roadmap summary

export_roadmap_summary
Read-onlyIdempotent

A short Markdown summary of a roadmap: lanes, items and milestones with dates, progress, checklists and dependencies.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "roadmapId": "<roadmapId>"
    },
    "name": "export_roadmap_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
roadmapIdYesRoadmap id from list_roadmaps

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare this read-only, idempotent, closed-world and non-destructive, so the safety profile is covered. The description adds meaningful behavior beyond that by disclosing the return format (Markdown) and exactly which roadmap elements appear in the output, which matters since no output schema exists. It stops short of saying what 'short' means, e.g. whether large roadmaps are truncated.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One dense sentence that front-loads the output format and enumerated contents, with no redundant or filler wording. Nothing could be removed without losing information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read tool with full schema coverage and an annotation set that covers safety, the description supplies the one thing structured data does not: what the returned Markdown contains. The only real gap is the undefined size/truncation behavior of a 'short' summary.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is a single parameter with 100% schema description coverage that already explains it is a roadmap id from list_roadmaps. The description adds no further meaning about the id's format or behavior, which is acceptable given the schema does the work, but it earns no credit beyond the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names the exact artifact produced: a short Markdown summary of a roadmap, enumerating the included content (lanes, items, milestones, dates, progress, checklists, dependencies). This is specific about output form and content, but it never explicitly contrasts with the sibling get_roadmap, so the agent must infer that this is the condensed/rendered view rather than the full structured fetch.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Use is only implied: the words 'short summary' and the Markdown output format suggest a quick human-readable overview, in contrast to a raw data fetch. There is no explicit when-to-use statement, no mention of when the full get_roadmap is preferable, and no stated prerequisites beyond the roadmap id.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources