documentation-mcp CLAUDE.md

documentation-mcp CLAUDE.md is an instructions file for coding agents from syamai/documentation-mcp. It costs 793 tokens per session, scanned A, original, MIT.

Project instructions for an MCP server that analyzes TypeScript and JavaScript code to generate documentation.

In plain words
What is it for?
Use it when working on the documentation-mcp project or changing its code-analysis and document-generation tools.
Why use it?
It gives developers the commands and design details needed to build, test, lint, and run the documentation server.

Instructions file

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/syamai/documentation-mcp/claude-md
Clone the repo
git clone --depth 1 https://github.com/syamai/documentation-mcp

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/syamai/documentation-mcp/claude-md.svg)](https://agentmods.dev/instructions/syamai/documentation-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/syamai/documentation-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/syamai/documentation-mcp/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 793 This file is loaded in full into every session.
When invoked 793 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00793 $0.00793
Opus 5 $0.00396 $0.00396
Sonnet 5 $0.00159 $0.00159
Haiku 4.5 $0.00079 $0.00079

Measured 4d ago against content hash 774b12d4b6e4, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

documentation-mcp CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

CLAUDE.md · 80 lines

How it starts

The opening of the file, as written. The whole thing — 80 lines — stays where its author put it; the contents beside it link to each section on GitHub.

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

An MCP (Model Context Protocol) server that automatically generates documentation from codebase analysis. It parses TypeScript/JavaScript files using AST analysis, extracts JSDoc comments, and generates README, API documentation, Mermaid diagrams, and CHANGELOG.

Build & Development Commands

npm run build       # Compile TypeScript and copy templates to dist/
npm run dev         # Watch mode for TypeScript compilation
npm run start       # Run the compiled MCP server
npm test            # Run tests with Vitest
npm run lint        # ESLint check on src/
npm run clean       # Remove dist/ directory

Architecture

MCP Server Pattern

  • Entry: src/index.ts - CLI entry point, handles doc-gen [project-path]
  • Server: src/server.ts - DocumentationMCPServer class using @modelcontextprotocol/sdk, communicates via stdio transport

Tool Registry Pattern

Tools are registered in src/tools/index.ts with a Map-based registry:

registerTool(toolDefinition, handlerFunction)

Each tool file exports:

  • {toolName}Tool: Tool - MCP tool definition with inputSchema
  • handle{ToolName}(args, context): Promise<ToolResponse> - Handler function

Available Tools

Tool Purpose
doc-init Initialize .doc-generator/ with config.json and state.json
doc-status Show current documentation status and coverage
doc-analyze Analyze codebase, extract functions/classes/interfaces/types/API endpoints
doc-generate Generate documentation (readme, api, diagram, changelog)

Core Modules

  • src/core/code-analyzer.ts - TypeScript AST analysis using typescript package, extracts:
    • Functions with signatures, parameters, return types
    • Classes with properties, methods, constructors
    • Interfaces and type aliases
    • Enums with members
    • API endpoints (Express/Fastify routes)
    • JSDoc comments and tags

Read the full file on GitHub · 80 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 80 lines · 793 tokens per session scan A 774b12d4b6e4

Subscribe to this mod's changes

documentation-mcp CLAUDE.md is an instructions file published in the GitHub repository syamai/documentation-mcp (0 stars, last pushed 7mo ago), licensed MIT. It adds 793 tokens to every session, about $0.0040 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-01.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens