LivingDocs

MCPAI代理

提供方 dinesh-mys

AI代理 未标注 会话登录 社区 / 第三方 Claude DesktopClaudeCursorVS Code

AI-powered documentation health monitor — detects stale doc comments and suggests updates using Claude. Works as an MCP server for Claude Desktop, Claude Code, and GitHub Copilot.

一句话选型结论

按资料字段整理

LivingDocs 属于AI代理类 MCP 服务器,传输方式未标注,会话登录,可直接接入 Claude Desktop、Claude、Cursor 等,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

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

工具与能力

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

能力标签

claude mcp documentation dotnet ai copilot

支持客户端

适用场景

claudemcpdocumentation

安装与配置

未标注 会话登录
上游未给出传输方式
  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

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

  3. 3
    写入客户端配置

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

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

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

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

多步任务编排

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

自动化重复流程

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

选择建议

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

值得选的地方

  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 使用前要准备好会话登录对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在AI代理场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

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

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
LivingDocs当前 未标注 未标注 未标注 无 未标注
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代理
字段来自项目仓库与公开索引,中文说明由本站标注
提供方dinesh-mys上游标注的维护方 dinesh-mys
分类AI代理本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式会话登录远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Cross-platform本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验未标注上游最后核验时间

详细介绍

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

AI-powered documentation health monitor. Detects stale code comments, finds knowledge gaps, alerts on departure risk, and ingests Slack, Teams, and email conversations — so your entire org's knowledge stays searchable and current.

Install

Requires .NET 10 SDK.```bash
dotnet tool install -g LivingDocs.Mcp


## Tools

| Tool | Tier | Description |
|------|------|-------------|
| `scan_repo` | Free | Scan a repo and list stale doc files with staleness % (0–100%) |
| `query_docs` | Free | Answer natural-language questions about your codebase using its doc comments |
| `index_repo` | Free | Build or refresh the semantic search index for a repository |
| `suggest_doc_update` | Free | Ask Claude to rewrite a stale doc comment |
| `write_back` | Free | Write Claude-generated doc updates directly to source files |
| `detect_gaps` | Free | Find files with zero documentation, ranked by commit activity |
| `departure_risk` | Free | Identify authors who are the sole contributor to critical files (bus factor) |
| `write_docs` | Pro | Write updated docs to `docs/.md` with a UTC timestamp — full audit trail |
| `sync_confluence` | Pro | Write updated docs back to Confluence pages |
| `scan_org` | Pro | Scan all repos in a GitHub org and return an org-wide report |
| `index_slack` | Pro | Index a Slack channel into the knowledge base — searchable via `query_docs` |
| `index_teams` | Pro | Index a Microsoft Teams channel into the knowledge base |
| `index_email` | Pro | Index an IMAP email folder into the knowledge base |

## Quick test```bash
livingdocs-mcp scan /path/to/your/repo
``````
Scanning /path/to/repo ...
Files examined : 12
Stale docs     : 2

  [██████████]  100%  src/Tax.cs
               doc updated : 2024-09-01
               code changed: 2025-01-15

  [████░░░░░░]   40%  src/Auth.cs
               doc updated : 2024-12-01
               code changed: 2025-01-28

Setup — Claude Desktop

Edit ~/Library/Application Support/Claude/claude_desktop_config.json:```json
{
"mcpServers": {
"livingdocs": {
"command": "livingdocs-mcp",
"env": {
"ANTHROPIC_API_KEY": "sk-ant-..."
}
}
}
}


Restart Claude Desktop. The tools will appear under the **+** menu.

---

## Setup — Claude Code

Add a `.mcp.json` file to your project root:```json
{
  "mcpServers": {
    "livingdocs": {
      "command": "livingdocs-mcp",
      "env": {
        "ANTHROPIC_API_KEY": "sk-ant-..."
      }
    }
  }
}

Or register globally:```bash
claude mcp add livingdocs -s user -- livingdocs-mcp


Then in Claude Code chat:```
scan this repo for stale docs              → uses scan_repo
what does the Auth module do?              → uses query_docs
suggest a fix for src/Tax.cs              → uses suggest_doc_update
find undocumented files                   → uses detect_gaps
who owns the payments module?             → uses departure_risk

Setup — GitHub Copilot (VS Code)

VS Code 1.99+ supports MCP servers in Copilot agent mode. Add a .vscode/mcp.json file to your project:```json
{
"servers": {
"livingdocs": {
"type": "stdio",
"command": "livingdocs-mcp",
"env": {
"ANTHROPIC_API_KEY": "sk-ant-..."
}
}
}
}


Open the Copilot chat panel, switch to **Agent mode**, and the tools will be available.

> **Note:** The `@livingdocs` Copilot Extension agent is built and deployed but pending GitHub Copilot plan availability for agent URL registration. The MCP server path above works fully in the meantime.

---

## Setup — GitHub Webhook

The webhook integration watches every PR merge in your repo and automatically posts a stale-doc report as a PR comment. Optionally sends a Slack notification with an **Auto-draft** button that generates doc fixes in one click.

### 1. Deploy LivingDocs.CopilotExt

The webhook handler runs as a web service. Deploy it to any host (Railway, Fly.io, a VPS):```bash
# Docker
docker build -t livingdocs-ext .
docker run -p 8080:8080 \
  -e ANTHROPIC_API_KEY=sk-ant-... \
  -e GITHUB_WEBHOOK_SECRET=your-secret \
  -e LIVINGDOCS_REPO_PATH=/path/to/local/repo \
  livingdocs-ext

2. Register the webhook in GitHub

Go to your repository → Settings → Webhooks → Add webhook:

Field Value
Payload URL https://your-server/api/github/webhook
Content type application/json
Secret Any random string — set as GITHUB_WEBHOOK_SECRET
Events Select individual events → check Pull requests only

3. Set required environment variables

Variable Required Description
GITHUB_WEBHOOK_SECRET Yes Must match the secret entered in GitHub
LIVINGDOCS_REPO_PATH Yes Absolute path to the local clone of the repository
GITHUB_TOKEN Recommended PAT with repo scope — needed to post PR comments and fetch diffs
ANTHROPIC_API_KEY Yes For AI impact analysis and semantic doc mapping
SLACK_WEBHOOK_URL Optional Incoming webhook URL for Slack stale-doc alerts
SLACK_SIGNING_SECRET Optional Enables the Auto-draft Slack button (Slack App → Basic Information)

4. What happens on each merged PR

  1. GitHub sends a pull_request event with action: closed, merged: true
  2. LivingDocs validates the HMAC-SHA256 signature
  3. Fetches changed files from the GitHub API
  4. Runs stale-doc detection against the local repo
  5. Calls Claude to analyse the diff and map affected .md docs
  6. Posts a report as a PR comment
  7. Sends a Slack notification (if configured) with an Auto-draft top doc button

Pro tier

7-day free trial available — no credit card required to start.

Pro tools require a license key:```bash
export LIVINGDOCS_LICENSE_KEY=LD-xxxx-xxxx-xxxx


Or add it to the `env` block in your MCP config:```json
{
  "mcpServers": {
    "livingdocs": {
      "command": "livingdocs-mcp",
      "env": {
        "ANTHROPIC_API_KEY": "sk-ant-...",
        "LIVINGDOCS_LICENSE_KEY": "LD-xxxx-xxxx-xxxx"
      }
    }
  }
}

Start a 7-day free trial — LivingDocs Pro (then $10/month).


Free tool — detect_gaps

Finds source files that have zero documentation comments and ranks them by commit activity. The busiest undocumented files are the highest-priority knowledge gaps — code that changes frequently but is never explained.

Usage in Claude:```
detect_gaps on /path/to/repo


**Example output:**```
Knowledge gaps in '/path/to/repo'
Files scanned: 42  |  Documented: 28  |  Undocumented: 14 (33%)

Top undocumented files by activity:
  src/payments/retry.ts          42 commits    last changed 2024-11-03  by Alice
  src/auth/session.ts            31 commits    last changed 2025-01-08  by Bob

To add docs to the highest-priority file, run:
  suggest_doc_update on /path/to/repo src/payments/retry.ts

Free tool — departure_risk

Identifies authors who are the sole or dominant contributor to critical files — the classic "bus factor 1" problem. Files where one person accounts for ≥60% of commits and has ≥5 total commits are flagged as single points of knowledge.

Usage in Claude:```
departure_risk on /path/to/repo


**Example output:**```
Departure risk analysis for '/path/to/repo'
Files analysed: 42  |  High-risk files: 8

Authors with exclusive knowledge:

  Alice Chen  (6 files)
    • src/auth/session.ts        12 commits  (83% by Alice Chen)
    • src/payments/retry.ts       9 commits  (75% by Alice Chen)

  Bob Smith  (2 files)
    • src/core/engine.go         22 commits  (91% by Bob Smith)

To generate a handover doc for the riskiest file:
  suggest_doc_update on /path/to/repo src/auth/session.ts

Pro tool — write_docs

Detects stale doc comments in a file, generates updated documentation via Claude, and appends the results to docs/.md inside your repository — with a UTC timestamp on every run. Each run adds a new dated section, building a full audit trail of how your documentation evolved over time.

Usage in Claude:```
write_docs on /path/to/repo for src/Tax.cs


Creates or appends to `docs/Tax.md`:```markdown
# Tax.cs — LivingDocs Documentation

## 2026-05-19

### TaxCalculator.Calculate
Calculates net tax payable given gross income, deductions, and the current financial year slab rates...

*Confidence: 92%*

---

Pro tool — sync_confluence

Detects stale doc comments in a file, generates updated documentation via Claude, and writes the results to the matching Confluence page (creates it if it doesn't exist).

Required env vars:

Variable Description
CONFLUENCE_BASE_URL Your Confluence Cloud URL, e.g. https://mycompany.atlassian.net/wiki
CONFLUENCE_EMAIL Atlassian account email
CONFLUENCE_API_TOKEN API token from id.atlassian.com/manage-profile/security/api-tokens
CONFLUENCE_SPACE_KEY Target space key, e.g. DEV (visible in the space URL)

Usage in Claude:```
sync_confluence on /path/to/repo for src/Tax.cs


---

## Pro tool — scan_org

Scans every repository in a GitHub organisation and returns an org-wide staleness report. Shallow-clones each repo, runs stale-doc detection, then cleans up.

**Required env vars:**

| Variable | Description |
|----------|-------------|
| `GITHUB_TOKEN` | Personal access token with `repo` and `read:org` scopes |

**Usage in Claude:**```
scan_org on my-company

Example output:```
Org: my-company — 8 repos scanned | 142 files | 5 stale docs

⚠️ Repos with stale docs
api-service — 3 stale / 48 files
- src/Auth.cs (100%)
- src/Tax.cs (80%)

✅ Clean repos (6)
frontend, user-service, admin-api, ...


---

## Pro tool — index_slack

Fetches messages from a Slack channel and adds them to the repository's knowledge index. Once indexed, `query_docs` returns results from Slack discussions **alongside code documentation** — so "why did we choose Postgres?" finds both code comments and the Slack thread where the decision was made.

Threads are grouped so context is preserved. Bot messages, join/leave events, and messages under 30 characters are filtered out automatically.

**Required env vars:**

| Variable | Description |
|----------|-------------|
| `SLACK_BOT_TOKEN` | Bot token (`xoxb-...`) — Slack App → OAuth & Permissions |

**Bot OAuth scopes required:** `channels:history`, `channels:read`

**Usage in Claude:**```
index_slack on /path/to/repo C1234ABCD

Then query across code + Slack:```
query_docs on /path/to/repo "how does the auth flow work?"


---

## Pro tool — index_teams

Fetches messages from a Microsoft Teams channel via the Graph API and adds them to the knowledge index. Uses client credentials OAuth — no user sign-in required.

**Required env vars:**

| Variable | Description |
|----------|-------------|
| `TEAMS_TENANT_ID` | Azure AD tenant ID |
| `TEAMS_CLIENT_ID` | Azure AD app (client) ID |
| `TEAMS_CLIENT_SECRET` | Azure AD client secret |

**Azure AD app setup:**
1. Register an app in Azure portal → App registrations
2. Add application permission: `ChannelMessage.Read.All`
3. Grant admin consent
4. Create a client secret
5. Get team/channel IDs from Graph Explorer

**Usage in Claude:**```
index_teams on /path/to/repo <teamId> <channelId>

Pro tool — index_email

Fetches emails from an IMAP mailbox folder and adds them to the knowledge index. Engineering discussions, incident reports, and architectural decisions in email become searchable alongside code documentation. Email quoting (> lines) is stripped automatically.

Works with Gmail app passwords, Microsoft 365, and any standard IMAP provider.

Required env vars:

Variable Description
IMAP_HOST IMAP server hostname, e.g. imap.gmail.com
IMAP_USERNAME Email address
IMAP_PASSWORD Password or app password
IMAP_PORT Port (default 993)

Gmail setup: Use an App Password — not your account password. Requires 2-Step Verification.

Usage in Claude:```
index_email on /path/to/repo folder=Engineering


For best results, create a dedicated folder (e.g. `Engineering/Architecture`) and filter relevant emails into it.

---

## Enterprise tier

Enterprise licenses run fully offline — no internet required for license validation. Ideal for air-gapped environments and regulated industries.

**How it works:**
1. Contact **dinesh@novaders.com** with your company name and team size
2. Receive a signed JWT license key and invoice
3. Set `LIVINGDOCS_LICENSE_KEY=` — validation happens locally, no external API calls

**Enterprise features:**
- Offline JWT license validation (RSA-256 signed — works in air-gapped networks)
- Azure OpenAI support — use your own Azure deployment instead of Anthropic
- Self-contained binary — no .NET SDK required, download from GitHub Releases
- Priority support and custom invoicing (annual or one-time)

**Azure OpenAI setup:**```json
{
  "mcpServers": {
    "livingdocs": {
      "command": "livingdocs-mcp",
      "env": {
        "LIVINGDOCS_LICENSE_KEY": "<enterprise-jwt>",
        "AZURE_OPENAI_ENDPOINT": "https://your-resource.openai.azure.com",
        "AZURE_OPENAI_API_KEY": "your-azure-key",
        "AZURE_OPENAI_DEPLOYMENT": "gpt-4o"
      }
    }
  }
}

Environment variables

Variable Required Description
ANTHROPIC_API_KEY Yes (AI features) Anthropic API key — not needed if using Azure OpenAI
LIVINGDOCS_LICENSE_KEY Yes (Pro/Enterprise) LD-xxxx key from Polar.sh or JWT from Novaders LLP
AZURE_OPENAI_ENDPOINT Enterprise Azure OpenAI resource endpoint
AZURE_OPENAI_API_KEY Enterprise Azure OpenAI API key
AZURE_OPENAI_DEPLOYMENT Enterprise Azure OpenAI deployment name, e.g. gpt-4o
GITHUB_TOKEN Recommended PAT with repo + read:org scopes — for scan_org, PR comments, and private repos
GITHUB_WEBHOOK_SECRET Webhook HMAC secret — must match the secret set in GitHub repo webhook settings
LIVINGDOCS_REPO_PATH Webhook Absolute path to the local repo clone for the webhook handler to scan
CONFLUENCE_BASE_URL sync_confluence Confluence Cloud URL, e.g. https://mycompany.atlassian.net/wiki
CONFLUENCE_EMAIL sync_confluence Atlassian account email
CONFLUENCE_API_TOKEN sync_confluence Atlassian API token
CONFLUENCE_SPACE_KEY sync_confluence Confluence space key, e.g. DEV
SLACK_WEBHOOK_URL Optional Incoming webhook URL for stale-doc Slack alerts after PR merges
SLACK_SIGNING_SECRET Optional Enables the Auto-draft button in Slack notifications (Slack App → Basic Information)
SLACK_BOT_TOKEN index_slack Bot token (xoxb-...) with channels:history + channels:read scopes
TEAMS_TENANT_ID index_teams Azure AD tenant ID
TEAMS_CLIENT_ID index_teams Azure AD app (client) ID
TEAMS_CLIENT_SECRET index_teams Azure AD client secret
IMAP_HOST index_email IMAP server hostname, e.g. imap.gmail.com
IMAP_USERNAME index_email Email address / IMAP login
IMAP_PASSWORD index_email Password or app password
IMAP_PORT index_email IMAP port — defaults to 993 (SSL)
DO_NOT_TRACK Optional Set to 1 to disable anonymous telemetry (see below)
LIVINGDOCS_TELEMETRY Optional Set to off to disable anonymous telemetry (see below)

Telemetry

LivingDocs sends a small amount of anonymous usage data so we can see which
setup steps people complete (install, server start, first successful index, and
when an upgrade prompt is shown). Each event contains only a random installation
ID, the app version, and your OS — never your code, file paths, repository
names, or any personal data.

To opt out, set either environment variable:```
DO_NOT_TRACK=1

or

LIVINGDOCS_TELEMETRY=off


## Supported languages

C#, TypeScript, JavaScript, Python, Go

## Build from source```bash
git clone https://github.com/dinesh-mys/livingdocs
cd livingdocs
make build
make test
make scan REPO=/path/to/your/repo

Architecture```

┌──────────────────────────────────────────────────────────────┐
│ Interfaces │
│ Claude Desktop │ Claude Code │ VS Copilot │ GitHub Webhook │
└───────┬──────────────────────────────────────┬───────────────┘
│ │
livingdocs-mcp LivingDocs.CopilotExt
(MCP server) /api/github/webhook
│ /api/slack/actions
│ /api/copilot/chat (SSE)
└──────────────────┬─────────┘
LivingDocs.Core
┌────────────────────────┴────────────────────────────────┐
GitScanner DocExtractor StaleDocDetector ClaudeService
GapDetector DepartureRisk IndexService DocWriterService
SlackConnector TeamsConnector EmailConnector ConfluenceService
```

Projects

Project Purpose
LivingDocs.Core Shared engine — git scanning, doc extraction, stale detection, Claude API, knowledge gap + departure risk analysis, Slack/Teams/Email connectors, Confluence sync, org scanning
LivingDocs.McpServer CLI + MCP server — published as LivingDocs.Mcp on NuGet
LivingDocs.CopilotExt GitHub webhook handler, Slack notifications + approval flow, Copilot Extension SSE endpoint
LivingDocs.Tests xUnit test suite (94 tests)

Feedback & Support

  • Bug reports → GitHub Issues
  • Feature requests → GitHub Issues
  • Questions & ideas → GitHub Discussions

License

MIT — see LICENSE.

常见问题

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

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

LivingDocs 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式未标注,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

LivingDocs 收费吗?

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

LivingDocs 需要 API Key 吗?

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

LivingDocs 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor、VS Code、Codex、Zed;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

LivingDocs 能提供哪些能力?

资料显示能力标签包括 claude、mcp、documentation、dotnet、ai、copilot。具体工具清单以官方文档为准。

LivingDocs 需要什么运行环境?

运行时为 Cross-platform。

热门专题

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

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