English Français العربية

io.github.aissablk1/mcp-roadmapsh

السجل الرسمي أخرى

MCP server for roadmap.sh: roadmaps, best practices, interview questions, projects & progress

الشيفرة المصدرية التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package mcp-roadmapsh
Claude Code 
claude mcp add mcp-roadmapsh -- npx -y mcp-roadmapsh@0.2.0
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "mcp-roadmapsh": {
            "command": "npx",
            "args": [
                "-y",
                "mcp-roadmapsh@0.2.0"
            ]
        }
    }
}

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. mcp-roadmapsh
  2. Prerequisite
  3. Quick start
  4. Tools
  5. Configuration (env)
  6. Publishing (maintainers)
  7. License

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 graphs
  • raw.githubusercontent.com/nilbuild/developer-roadmap — topic markdown
  • GitHub 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.

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-roadmapsh
Any 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 Inspector

Tools

ToolPurpose
roadmap_diagnoseConnectivity + cache/state status
roadmap_listList all roadmap slugs
roadmap_getRoadmap graph by slug (outline or raw)
roadmap_topicTopic markdown + links (by nodeId or query)
roadmap_exportExport a whole roadmap as markdown/text
roadmap_searchSearch slugs by keyword within a scope
best_practices_list / best_practices_getBest-practice guides
questions_list / questions_getInterview question groups
projects_list / project_getPractice project ideas
videos_listVideo resources
progress_markMark a topic learning / done / skip (local)
progress_statusCompletion percent for a roadmap
progress_nextRecommend the next topic to learn

Configuration (env)

VariableDefaultPurpose
ROADMAPSH_CACHE_DIR~/.cache/mcp-roadmapshHTTP cache directory
ROADMAPSH_CACHE_TTL_MS86400000 (24 h)Cache TTL
ROADMAPSH_STATE_DIR~/.local/state/mcp-roadmapshProgress state
ROADMAPSH_TIMEOUT_MS20000HTTP timeout
ROADMAPSH_OWNERnilbuildGitHub owner of the developer-roadmap repo
ROADMAPSH_BRANCHmasterdeveloper-roadmap branch
GITHUB_TOKEN—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

الأسئلة الشائعة

ما هو io.github.aissablk1/mcp-roadmapsh؟

MCP server for roadmap.sh: roadmaps, best practices, interview questions, projects & progress

كيف أثبّت io.github.aissablk1/mcp-roadmapsh؟

يعمل على جهازك. في Claude Code: claude mcp add mcp-roadmapsh -- npx -y mcp-roadmapsh@0.2.0. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.aissablk1/mcp-roadmapsh إلى مفتاح API؟

لا يذكر إدراجه في السجل أي مفتاح أو سر إلزامي. قد تتطلب بعض الميزات حسابًا لدى الخدمة التي يتصل بها.

هل io.github.aissablk1/mcp-roadmapsh مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.aissablk1/mcp-roadmapsh؟

ينشره aissablk1. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.