Skip to content

docs: document the MCP server - #134

Merged
itsflaid merged 1 commit into
mainfrom
docs/mcp-server
Oct 30, 2026
Merged

itsflaid merged 1 commit into
mainfrom
docs/mcp-server

Conversation

@itsflaid

Copy link
Copy Markdown
Owner

Ringkasan

Dokumentasi untuk devmap mcp (Fase 4, bagian docs). Hanya dokumen: tidak ada perubahan kode, tidak ada perubahan di packages/cli, tidak ada bump versi.

Baru

  • docs/mcp.md — panduan utama: quick start, setup untuk Claude Code / Cursor / opencode / Codex, flag, referensi 8 tool (input dan field hasil), resource dan prompt, model freshness, model AI dan privasi, error, keamanan, troubleshooting, batasan.
  • docs/guide/commands/09-mcp.md — catatan implementasi (stdout sebagai protokol, snapshot provider, refresher + lock, kenapa devmap_explain terdaftar kondisional, peta tes).

Diperbarui

  • README.md — bagian "MCP Server" + tautan docs
  • docs/commands.md — section devmap mcp, catatan --json
  • docs/architecture.md — bagian 15 "Front-ends: CLI and MCP" (AI boundary tidak bergeser, konkurensi, freshness)
  • docs/generated-files.md — .devmap/analyze.lock dan apa yang ditulis server MCP
  • docs/guide/README.md, docs/guide/index.md
  • CLAUDE.md — struktur, komponen, jumlah tes, constraint stdout/AI, catatan engineering
  • CHANGELOG.md — [Unreleased] / Added (versi sengaja belum ditentukan)
  • docs/for-me-personal/{PROGRESS,TEST,DEBUG}.md sesuai aturan AGENTS.md (DEBUG: entri Strengthen Ask retrieval confidence #30; entri baru memakai LF sesuai .gitattributes, file lama tidak diubah selain baris tanggal)

Verifikasi

  • Nama tool, flag, dan konstanta (batas ukuran, timeout, TTL, umur lock) di docs dicocokkan dengan kode.
  • Semua link relatif dicek; satu yang rusak sudah ada sebelumnya dan bukan dari PR ini: README.md → ./docs/roadmap.md (file tidak ada).
  • Format setup tiap client diverifikasi ke dokumentasi resmi masing-masing (Claude Code claude mcp add … --, Cursor mcp.json + ${workspaceFolder}, opencode type: local + command array, Codex [mcp_servers.*]). Dua catatan praktis masuk docs: timeout tool Codex default 60 detik, dan timeout opencode default 5 detik.
  • git diff --check ✅

Yang sengaja tidak ada di PR ini

  • packages/cli/README.md ikut tarball npm, jadi diubah bersama bump versi di PR rilis (aturan AGENTS.md: perubahan di packages/cli menunggu konfirmasi level bump).
  • Landing page: PR terpisah.

Generated by Claude Code

Add docs/mcp.md (setup for Claude Code, Cursor, opencode and Codex, tools, freshness, AI and privacy model, troubleshooting) and docs/guide/commands/09-mcp.md (implementation notes). Update README, commands.md, architecture.md (front-ends), generated-files.md (analyze.lock), the guide index, CLAUDE.md and CHANGELOG (Unreleased). Record progress, test steps and one debugging incident in docs/for-me-personal.
@vercel

vercel Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
devmap-web Ready Ready Preview Oct 30, 2026 2:58am UTC

@github-actions

Copy link
Copy Markdown

✅ Welcome ke DevMap!

Terima kasih sudah buat PR. Pastikan checklist ini terpenuhi sebelum review:

  • devmap doctor lolos (tanpa error)
  • Test pnpm test:cli lolos (semua pass)
  • New commands diupdate di docs/commands.md
  • Tidak ada console.log di command files
  • Registry terms sesuai standar (baca docs/guide/05-signal-registry.md)
  • Code style match dengan CONTRIBUTING.md

CI akan jalan otomatis pada setiap update. Kalau gagal, akan muncul link run di komentar ini.

Kalau DevMap membantu, tolong star ya: https://github.com/itsflaid/devmap

Terima kasih kontribusinya! 🙏

@itsflaid
itsflaid merged commit cb6f6ee into main Oct 30, 2026
3 checks passed
@itsflaid
itsflaid deleted the docs/mcp-server branch October 30, 2026 08:54

This branch was successfully deployed

1 active deployment
Preview — c14ef8a7 Deployed Oct 30, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants