English Français العربية

io.github.rog0x/docs

السجل الرسمي الإنتاجية

JSDoc, README, changelog generation for AI agents

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

التثبيت

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

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

التوثيق

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

المحتويات
  1. mcp-docs-tools
  2. Overview
  3. Installation
  4. Usage
  5. Configuration
  6. License

mcp-docs-tools

Documentation generation tools for AI agents, served via the Model Context Protocol (MCP).

Overview

mcp-docs-tools provides five specialized documentation tools accessible through MCP:

ToolDescription
generate_jsdocGenerate JSDoc/TSDoc comments from function signatures
analyze_readmeAnalyze README completeness and suggest improvements
generate_changelogGenerate CHANGELOG entries from commit messages
generate_api_docsGenerate REST API documentation from endpoint definitions
analyze_code_commentsAnalyze comment coverage, find TODOs, detect undocumented functions

Installation

npm install
npm run build

Usage

As an MCP Server

Add to your MCP client configuration:

{
  "mcpServers": {
    "docs-tools": {
      "command": "node",
      "args": ["path/to/mcp-docs-tools/dist/index.js"]
    }
  }
}
Tools
generate_jsdoc

Parses a function signature and generates JSDoc/TSDoc with @param, @returns, @throws, and @example tags.

Parameters:

  • functionSignature (string, required) - The function signature to document
  • description (string, optional) - Description of the function
  • includeExample (boolean, optional, default: true) - Whether to include an @example tag
analyze_readme

Analyzes README content for required sections (Installation, Usage, License, etc.), rates completeness from 0-100, and suggests missing sections.

Parameters:

  • content (string, required) - Full text content of the README file
generate_changelog

Generates CHANGELOG entries from git-style commit messages following the Keep a Changelog format. Categorizes commits as Added, Changed, Fixed, Removed, Deprecated, or Security.

Parameters:

  • versions (array, required) - Array of { version, date, commits } objects
  • projectName (string, optional) - Project name for the header
generate_api_docs

Generates REST API documentation in Markdown from endpoint descriptions including method, URL, parameters, request/response examples, and status codes.

Parameters:

  • apiTitle (string, required) - Title for the API documentation
  • baseUrl (string, optional) - Base URL for the API
  • apiDescription (string, optional) - General API description
  • endpoints (array, required) - Array of endpoint definitions
analyze_code_comments

Analyzes source code comment coverage: computes comment-to-code ratio, finds TODO/FIXME/HACK markers, detects functions without documentation, and suggests where docs are needed.

Parameters:

  • code (string, required) - Source code to analyze
  • language (string, optional, default: "typescript") - Programming language

Configuration

No additional configuration required. The server runs over stdio.

License

MIT

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

ما هو io.github.rog0x/docs؟

JSDoc, README, changelog generation for AI agents

كيف أثبّت io.github.rog0x/docs؟

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

هل يحتاج io.github.rog0x/docs إلى مفتاح API؟

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

هل io.github.rog0x/docs مفتوح المصدر؟

شيفرته علنية على GitHub، لكن المستودع لا يعلن ترخيصًا قياسيًا.

من يصون io.github.rog0x/docs؟

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

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