Skip to main content
Glama
Sign In
mcp-roadmapsh

mcp-roadmapsh

by aissablk1
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

roadmap_export

Read-onlyIdempotent

Export a roadmap.sh roadmap as a single Markdown document. Optionally include topic content, cap the number of topics, or return only the structure.

Instructions

Export an entire roadmap as a single markdown document (all topics' content concatenated). includeContent=false returns structure only; maxTopics caps the count.

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": {
      "slug": "<slug>"
    },
    "name": "roadmap_export"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesroadmap.sh slug, e.g. 'frontend'
formatNoOutput format: markdown (default) or plain text for LLM ingestionmarkdown
maxTopicsNoCap the number of topics fetched (default: all)
includeContentNoFetch each topic's markdown; false returns structure only

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the description doesn't need to cover safety. It adds behavioral context by stating the output is a single concatenated markdown document and that includeContent=false yields structure only, which is useful beyond what annotations provide.

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?

The description is concise and front-loaded with the core purpose. Two sentences with no redundant phrases. It efficiently communicates the tool's function and key parameter behaviors without wasting words.

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 read-only export tool with full schema coverage and safety annotations, the description is sufficiently complete. It explains the output format and key options. It could explicitly mention when to use this instead of related tools, but given the sibling context, the 'entire roadmap' phrasing is adequate.

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?

Schema description coverage is 100%, so the schema already explains all four parameters. The description's mention of includeContent and maxTopics essentially repeats the schema descriptions without adding new semantic details. Baseline 3 is appropriate because the description doesn't provide value beyond the schema.

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

Purpose5/5

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

The description clearly states the action ('Export'), resource ('an entire roadmap'), and output form ('a single markdown document'). It also explains the concatenation of all topics' content, which distinguishes it from sibling tools like roadmap_get or roadmap_topic that likely return single items.

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

Usage Guidelines4/5

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

The description implies when to use this tool ('Export an entire roadmap') and provides conditional usage for parameters ('includeContent=false returns structure only; maxTopics caps the count'). It doesn't explicitly name alternatives or exclusions, so it falls short of a perfect 5, but the context is clear.

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

Deploy Server

Other Tools