mcp-roadmapsh
Provides tools to list and retrieve developer roadmaps, topic markdown, best practices, interview questions, project ideas, videos, and local progress tracking using the roadmap.sh platform.
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., "@mcp-roadmapsh show me the backend development roadmap"
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.
mcp-roadmapsh
MCP server for roadmap.sh — developer roadmaps, best
practices, interview questions, project ideas, videos, and local progress
tracking. Built on the official @modelcontextprotocol/sdk (TypeScript / stdio).
All data comes from official, public sources — no scraping, no mock data:
https://roadmap.sh/{slug}.json— rendered roadmap graphsraw.githubusercontent.com/nilbuild/developer-roadmap— topic markdownGitHub contents API — dynamic slug listings
Prerequisite
Node.js 20 or newer (node --version to check). That is
the only requirement — npx (bundled with Node) handles the rest, no manual
clone or build needed.
Related MCP server: Aindreyway MCP Codex Keeper
Quick start
Claude Code (one command)
# Once published to npm:
claude mcp add roadmapsh -- npx -y mcp-roadmapsh
# Works today, straight from GitHub (npx builds it for you):
claude mcp add roadmapsh -- npx -y github:aissablk1/mcp-roadmapshAny MCP client (JSON config)
{
"mcpServers": {
"roadmapsh": { "command": "npx", "args": ["-y", "mcp-roadmapsh"] }
}
}Replace mcp-roadmapsh with github:aissablk1/mcp-roadmapsh to run the latest
GitHub version before the npm release.
From source (contributors)
git clone https://github.com/aissablk1/mcp-roadmapsh.git
cd mcp-roadmapsh
npm install # `prepare` builds dist/ automatically
npm test # end-to-end test against real data
node dist/index.js # stdio MCP server
npm run inspect # open the MCP InspectorTools
Tool | Purpose |
| Connectivity + cache/state status |
| List all roadmap slugs |
| Roadmap graph by slug ( |
| Topic markdown + links (by |
| Export a whole roadmap as markdown/text |
| Search slugs by keyword within a scope |
| Best-practice guides |
| Interview question groups |
| Practice project ideas |
| Video resources |
| Mark a topic learning / done / skip (local) |
| Completion percent for a roadmap |
| Recommend the next topic to learn |
Configuration (env)
Variable | Default | Purpose |
|
| HTTP cache directory |
|
| Cache TTL |
|
| Progress state |
|
| HTTP timeout |
|
| GitHub owner of the developer-roadmap repo |
|
| developer-roadmap branch |
| — | Optional, raises GitHub API rate limit |
Publishing (maintainers)
npm publish # to npmjs.com (npm login required first)
npx -y @modelcontextprotocol/publisher publish # to the official MCP registry (server.json)The package ships mcpName and a server.json so it can be listed in the
official Model Context Protocol registry.
License
MIT — Aïssa BELKOUSSA
Available Tools
16 toolsbest_practices_getARead-onlyIdempotent
Get a best-practice guide by slug (outline or raw graph).
Inputs: slug (required), format.
best_practices_listARead-onlyIdempotent
List all best-practice slugs.
Inputs: no named parameters.
progress_markA
Mark a roadmap topic as learning, done, or skip (stored locally).
Inputs: nodeId (required), status (required), roadmap (required), label.
progress_nextARead-onlyIdempotent
Recommend the next unlearned topic for a roadmap based on local progress.
Inputs: roadmap (required).
progress_statusBRead-onlyIdempotent
Get local progress for a roadmap: counts and completion percent.
Inputs: roadmap (required).
project_getARead-onlyIdempotent
Get the markdown brief for one practice project by slug.
Inputs: slug (required).
projects_listARead-onlyIdempotent
List all practice-project slugs.
Inputs: no named parameters.
questions_getARead-onlyIdempotent
Get the interview questions markdown for a question-group slug.
Inputs: slug (required).
questions_listARead-onlyIdempotent
List all interview question-group slugs.
Inputs: no named parameters.
roadmap_diagnoseARead-onlyIdempotent
Check connectivity to roadmap.sh and GitHub, and report cache/state status.
Inputs: no named parameters.
roadmap_exportARead-onlyIdempotent
Export an entire roadmap as a single markdown document (all topics' content concatenated). includeContent=false returns structure only; maxTopics caps the count.
Inputs: slug (required), format, maxTopics, includeContent.
roadmap_getARead-onlyIdempotent
Get a roadmap by slug. format=outline returns a readable topic plan with node ids; format=raw returns the full graph JSON.
Inputs: slug (required), format.
roadmap_listARead-onlyIdempotent
List all available roadmap slugs (role-based and skill-based).
Inputs: no named parameters.
roadmap_searchARead-onlyIdempotent
Search roadmap.sh slugs by keyword within a scope (roadmaps, best-practices, question-groups, projects, videos).
Inputs: query (required), scope.
roadmap_topicARead-onlyIdempotent
Get the markdown content and curated links for one topic of a roadmap (by nodeId from the outline, or by query).
Inputs: slug (required), query, nodeId.
videos_listARead-onlyIdempotent
List all video resource slugs.
Inputs: no named parameters.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 16 tools
Each tool targets a distinct resource type or action: list tools are clearly separated by resource (projects, roadmaps, best-practices, questions, videos), and roadmap_get, roadmap_topic, roadmap_export, and roadmap_search each serve unique purposes. Even the progress tools are distinct (mark, status, next).
Most tools follow a noun_verb pattern (e.g., projects_list, roadmap_get, best_practices_get). However, a few deviate: roadmap_topic uses a noun, progress_status and progress_next are noun_noun/noun_adjective. Overall, the pattern is mostly consistent with minor exceptions.
With 16 tools, the count slightly exceeds the typical 15-tool high-water mark, but the server covers multiple content domains (roadmaps, best practices, questions, projects, videos) plus progress tracking, so each tool earns its place. The scope justifies the number.
The surface provides list and get operations for all resource types, plus roadmap-specific features (topic retrieval, export, search) and progress tracking. Minor gaps exist: no per-topic content tool for best practices, and search is limited to slugs rather than full content, but these are workable.
Maintenance
Related MCP Connectors
A MCP server built for developers enabling Git based project management with project and personal…
Official MCP server for Lovable, the AI-powered full-stack app builder.
Official MCP server for Certifier to issue, manage, and track certificates and badges.
MCP server aggregating developer infrastructure deals, free tiers, and startup programs
Related MCP Servers
- AlicenseBqualityDmaintenanceA beginner-friendly Model Context Protocol (MCP) server that helps users understand MCP concepts, provides interactive examples, and lists available MCP servers. This server is designed to be a helpful companion for developers working with MCP. Also comes with a huge list of servers you can install.337 npm67Apache 2.0
- AlicenseAqualityDmaintenanceAn intelligent MCP server that serves as a guardian of development knowledge, providing AI assistants with curated access to latest documentation and best practices.484 npm1MIT
- FlicenseNot gradedqualityDmaintenanceThis MCP server exposes programming topic data and tools (search, practice suggestions) to help AI agents answer study questions, like 'How to study Python decorators?'.-
- AlicenseNot gradedqualityDmaintenanceOfficial MCP server for exerciseapi.dev — give your AI coding agent direct access to 2,198+ vetted exercises across 12 categories.41 npm3MIT