Documentation

Provides GitHub PR/issue data and a static documentation guide to generate LLM-ready documentation prompts.
  • typescript

0

GitHub Stars

typescript

Language

4 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

You run a lightweight HTTP MCP server that fetches GitHub PRs/issues server-side and returns a structured documentation guide plus the relevant data for your client LLM to generate documentation. It is stateless and designed to handle many concurrent clients, making it suitable for local or remote deployment.

How to use

You connect your MCP client to the server using the HTTP MCP endpoint. From there, you invoke the writeDocumentation tool, providing either a GitHub PR URL, an issue URL, or both, along with any notes you want to include. The server fetches the GitHub data on demand, combines it with the static documentation guide, and returns a formatted context. Your client LLM then generates the final documentation following the provided guide.

How to install

Before you begin, ensure you have Node.js 18+ installed on your machine.

Install dependencies, build the project, then start the server with the following steps.

npm install
npm run build
export GITHUB_TOKEN="ghp_your_github_token_here"
npm start

Available tools

writeDocumentation

Aggregates GitHub PR/issue data with the static documentation guide and returns a complete context prompt for the client LLM to generate documentation.

Built by
VeilStrat
AI signals for GTM teams
© 2026 VeilStrat. All rights reserved.All systems operational