Docs

io.github.rog0xPublished by GitHub account rog0xv1.0.2Updated Oct 24, 2026

JSDoc, README, changelog generation for AI agents

VerifiedSTDIODesktop onlyKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

Lets an assistant generate JSDoc, README, changelog, and REST API documentation and audit existing docs and code comments.

What you can do
Provides five documentation tools over MCP: generate_jsdoc turns a function signature into JSDoc/TSDoc with @param, @returns, @throws and @example tags; analyze_readme rates README completeness and suggests missing sections; generate_changelog builds changelog entries from commit messages; generate_api_docs produces Markdown REST API docs from endpoint definitions; and analyze_code_comments reports comment coverage, TODO/FIXME markers and undocumented functions.
When to use it
Useful when an assistant is asked to write or review project documentation: drafting doc comments, filling gaps in a README, turning commits into changelog entries, or documenting an API surface. It is a text-generation and analysis helper, not a repository or Git integration.
Requirements
Runs locally as a Node.js process over stdio, installed from the npm package @rog0x/mcp-docs-tools and built before use; the MCP client is configured to launch the built entry file with node. No accounts, API keys, environment variables or headers are declared.
Before you install
No credentials or network access are declared. The tools take source code, README text, commit messages and endpoint definitions as input, so whatever is passed to them is handled by the local server; review generated documentation before committing it.

Installation

In SourceWeft

  1. Open Docs in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

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

bash
npm installnpm run build

Usage

As an MCP Server

Add to your MCP client configuration:

json
{  "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

Source: README.md at commit 2ae3eb1

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v1.0.2LatestSep 16, 2026

Score

40% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts

    Declare a license in the repository or the registry entry.