Documentation MCP Server C7005c9e

MCPAI代理

提供方 RandellB-Ritense

AI代理 stdio · 本地进程 Token 社区 / 第三方
查看接入方式

一个为LLM文档生成提供GitHub PR/issue数据和文档模板的MCP服务器。

一句话选型结论

按资料字段整理

Documentation MCP Server C7005c9e 属于AI代理类 MCP 服务器,stdio · 本地进程,Token,有可直接复制的远程端点配置。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类AI代理 传输方式stdio · 本地进程 鉴权Token 部署方式支持远程部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 1 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

AI代理
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量1暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

适用场景

GitHub数据TypeScript本地部署文档生成MCP协议HTTP服务LLM集成

安装与配置

stdio · 本地进程 Token
客户端在本机拉起子进程,数据不出本机
docker run -d -p 3000:3000 \

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    确认你的客户端支持远程端点,并拿到服务地址。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 1 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
给代理接外部能力

让代理在任务中途调用搜索、数据库等真实工具。

多步任务编排

把一串操作拆成步骤,由代理按顺序执行。

自动化重复流程

把固定流程交给代理跑,减少手工操作。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 1 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好Token对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在AI代理场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Documentation MCP Server C7005c9e当前 1 stdio · 本地进程 支持远程部署 有 2026-05-17
Filesystem 560c4363 13 未标注 本地部署 无 2026-05-17
Server Everything (everything) 11 stdio · 本地进程 本地部署 有 2026-05-17
Time 7365cb6d 2 SSE · 服务端推送 远程部署 有 2026-05-18
Everything Claude Code 未标注 stdio · 本地进程 本地部署 有 2026-05-17
Openmemory 557e1585 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

AI代理
字段来自项目仓库与公开索引,中文说明由本站标注
提供方RandellB-Ritense上游标注的维护方 RandellB-Ritense
分类AI代理本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式Token远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Docker本地安装时用到的包标识与运行时
部署类型支持远程部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

7.3 KB
来自项目仓库与上游目录的原文,未做删改

Documentation MCP Server

A Model Context Protocol (MCP) server that provides GitHub PR/issue data along with a documentation guide for LLM-based documentation generation.

Overview

This MCP server is a data provider that:

  • Fetches GitHub PR and issue data server-side
  • Loads a static documentation template
  • Returns formatted context to the client LLM
  • Lets the client LLM generate the actual documentation
  • Runs as an HTTP service - can be deployed locally or remotely

Architecture Flow:```
User → Client LLM → HTTP → MCP Server
↓
Fetches GitHub data
↓
Returns guide + context
↓
Client LLM generates documentation
↓
User receives documentation


The server does NOT contain its own LLM - it aggregates data for the client's LLM to process.

## Features

- **HTTP Transport**: Uses StreamableHTTP for MCP communication
- **Stateless**: Supports multiple concurrent clients without session conflicts
- **Remote Deployment**: Run on a different machine from your MCP client
- **Single Tool**: `writeDocumentation` - aggregates GitHub data with documentation guide
- **Server-Side Fetching**: Automatically retrieves PR details, linked issues, and diffs
- **Static Template**: Uses a fixed documentation guide loaded at startup
- **No LLM Calls**: Returns raw context for the client LLM to process
- **Health Check**: Built-in `/health` endpoint for monitoring

## Quick Start

### 1. Install and Build```bash
npm install
npm run build

2. Set GitHub Token```bash

export GITHUB_TOKEN="ghp_your_github_token_here"


Get your token at: https://github.com/settings/tokens

### 3. Start the Server```bash
npm start

You should see:```
Documentation MCP Server running on http://0.0.0.0:3000
MCP endpoint: http://0.0.0.0:3000/mcp
Health check: http://0.0.0.0:3000/health
Mode: HTTP (stateless, multiple clients supported)


## Configuration

### Environment Variables

| Variable | Description | Default | Required |
|----------|-------------|---------|----------|
| `GITHUB_TOKEN` | GitHub Personal Access Token | - | Yes |
| `PORT` | HTTP server port | `3000` | No |
| `HOST` | HTTP server host | `0.0.0.0` | No |

### Examples```bash
# Custom port
PORT=8080 npm start

# Specific interface
HOST=127.0.0.1 npm start

# Both
PORT=8080 HOST=127.0.0.1 GITHUB_TOKEN=your_token npm start

Usage

Health Check

Test if the server is running:```bash
curl http://localhost:3000/health

Response: {"status":"ok","service":"documentation-mcp-server"}


### MCP Client Configuration

Configure your MCP client to connect to the server:```json
{
  "mcpServers": {
    "documentation": {
      "url": "http://localhost:3000/mcp",
      "transport": "http"
    }
  }
}

For remote servers:```json
{
"mcpServers": {
"documentation": {
"url": "https://your-server.com/mcp",
"transport": "http"
}
}
}


### Tool: writeDocumentation

**Input Parameters:**

- `prUrl` (string, optional): GitHub pull request URL
- `issueUrl` (string, optional): GitHub issue URL
- `notes` (string, optional): Additional context or notes

At least one of `prUrl` or `issueUrl` is required.

**Example Usage:**```
User: "Write documentation for https://github.com/owner/repo/pull/123"

Client LLM: [Calls writeDocumentation tool via HTTP]

MCP Server: [Fetches GitHub data, returns guide + context]

Client LLM: [Generates documentation following the guide]

User: [Receives completed documentation]

Output:

Returns a formatted prompt containing:

  1. The documentation guide (structure, rules, required sections)
  2. GitHub PR/issue data (title, description, files, diffs)
  3. Any additional notes provided
  4. Instructions for the client LLM to generate documentation

Deployment

Docker```dockerfile

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci --only=production
COPY . .
RUN npm run build
EXPOSE 3000
ENV PORT=3000
ENV HOST=0.0.0.0
CMD ["npm", "start"]


Build and run:```bash
docker build -t documentation-mcp-server .
docker run -d -p 3000:3000 \
  -e GITHUB_TOKEN=your_token \
  --name mcp-server \
  documentation-mcp-server

Docker Compose```yaml

version: '3.8'

services:
mcp-server:
build: .
ports:
- "3000:3000"
environment:
- GITHUB_TOKEN=${GITHUB_TOKEN}
- PORT=3000
- HOST=0.0.0.0
restart: unless-stopped
healthcheck:
test: ["CMD", "wget", "--quiet", "--tries=1", "--spider", "http://localhost:3000/health"]
interval: 30s
timeout: 10s
retries: 3


### Process Manager (PM2)```bash
npm install -g pm2
pm2 start dist/index.js --name mcp-server
pm2 save
pm2 startup

Cloud Platforms

Deploy to Railway, Render, Fly.io, or any platform supporting Node.js:

  1. Push your code to GitHub
  2. Connect repository to platform
  3. Set GITHUB_TOKEN environment variable
  4. Platform will auto-deploy

Testing

Test with curl```bash

Initialize

curl -X POST http://localhost:3000/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "initialize",
"params": {
"protocolVersion": "2024-11-05",
"capabilities": {},
"clientInfo": {"name": "test", "version": "1.0.0"}
}
}'

List tools

curl -X POST http://localhost:3000/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/list"
}'


## Architecture```
src/
├── index.ts           # MCP server with HTTP transport
└── github-client.ts   # GitHub API integration

documentation-guide.md # Static documentation template

How It Works

  1. Server Starts: Loads documentation guide, starts HTTP server
  2. Client Connects: MCP client connects to /mcp endpoint
  3. Tool Invocation: Client calls writeDocumentation with GitHub URLs
  4. Data Fetching: Server fetches PR/issue data from GitHub API
  5. Context Building: Server combines guide + GitHub data into formatted prompt
  6. Response: Server returns complete context via HTTP
  7. Generation: Client LLM generates documentation following the guide

Transport Details

  • Protocol: StreamableHTTP (MCP specification)
  • MCP Endpoint: GET/POST /mcp - Main MCP communication
  • Health Endpoint: GET /health - Status check
  • CORS: Enabled for all origins (configure for production)
  • Session Mode: Stateless (supports multiple concurrent clients)

Security

For production deployment:

  1. Configure CORS: Restrict allowed origins
  2. Use HTTPS: Deploy behind reverse proxy (nginx, Caddy)
  3. Rate Limiting: Add rate limiting middleware
  4. Authentication: Add auth tokens if needed
  5. GitHub Token: Keep secure, use environment variables
  6. Network: Use firewall rules to restrict access

Troubleshooting

See TROUBLESHOOTING.md for detailed solutions.

Common issues:

  • "Server already initialized": Fixed in latest version (stateless mode)
  • Connection refused: Server not running or wrong port
  • CORS errors: Configure CORS for your client origin
  • GitHub rate limits: Use a GitHub token

Requirements

  • Node.js 18+
  • TypeScript 5+
  • GitHub token (optional, but recommended)

License

MIT

常见问题

7 问
答案由本站依据条目字段整理,不引用上游原文
Documentation MCP Server C7005c9e 怎么安装?

在客户端按下面的安装命令接入:docker run -d -p 3000:3000 \。装完在客户端配置里引用同一个包或端点。

Documentation MCP Server C7005c9e 怎么在客户端里配置?

它的传输方式未标注,在客户端 MCP 配置里按官方文档填写启动命令和参数,保存后重启客户端生效。

Documentation MCP Server C7005c9e 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Documentation MCP Server C7005c9e 需要 API Key 吗?

资料标注需要Token认证,使用前准备好对应凭据,并按最小权限配置。

Documentation MCP Server C7005c9e 能提供哪些能力?

资料显示约 1 个工具;能力标签包括 文档生成、TypeScript、HTTP服务、模型集成。具体工具清单以官方文档为准。

Documentation MCP Server C7005c9e 需要什么运行环境?

运行时为 Docker;属于本地进程,需要在本机装好运行环境。

Documentation MCP Server C7005c9e 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。