What is update-full-docs?

A command for reviewing code changes and updating all documentation affected by them before a commit or pull request. It covers setup guides, references, architecture, testing, dependencies, integrations, and release notes.

Use it to inspect Git differences, classify the change, identify affected documents, and update the appropriate project guides and records.

It helps keep documentation accurate when the code, configuration, development process, or external integrations change.

update-full-docs — Command for Claude Code by istarwyh: A command for reviewing code changes and updating all…

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add commands/istarwyh/mcpadvisor/update-full-docs

Clone the repo

git clone --depth 1 https://github.com/istarwyh/mcpadvisor

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/commands/istarwyh/mcpadvisor/update-full-docs.svg)](https://agentmods.dev/commands/istarwyh/mcpadvisor/update-full-docs)

Your own site

<a href="https://agentmods.dev/commands/istarwyh/mcpadvisor/update-full-docs"><img src="https://agentmods.dev/badge/commands/istarwyh/mcpadvisor/update-full-docs.svg" alt="Measured on agentmods" height="20"></a>

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 2,530 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. Scan, not verified.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5	$0.00000	$0.02530
Opus 5	$0.00000	$0.01265
Sonnet 5	$0.00000	$0.00506
Haiku 4.5	$0.00000	$0.00253

Measured 4d ago against content hash 98cb6f27a711, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

update-full-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/commands/update-full-docs.md · 342 lines

How it starts

The opening of the file, as written. The whole thing — 342 lines — stays where its author put it; the contents beside it link to each section on GitHub.

文档更新命令

在每次commit或PR前，使用此命令确保所有相关文档都已正确更新。

使用方法

/update-docs [changes-description]

执行步骤

1. 分析代码变更

首先分析当前的代码变更，确定影响范围：

# 查看当前变更
git status
git diff --cached  # 查看已暂存的变更
git diff HEAD      # 查看所有变更

2. 识别需要更新的文档类型

根据变更类型，确定需要更新的文档：

🆕 新功能 (feat)

docs/GETTING_STARTED.md - 添加使用说明和配置选项
docs/TECHNICAL_REFERENCE.md - 添加技术实现细节
README.md / README_zh.md - 更新功能列表和示例
docs/ARCHITECTURE.md - 更新架构图和组件说明（如有结构变更）

🐛 Bug修复 (fix)

docs/TROUBLESHOOTING.md - 添加问题解决方案
CHANGELOG.md - 记录修复内容
相关功能文档 - 更新受影响的使用说明

🔧 配置变更 (config/env)

docs/GETTING_STARTED.md - 更新环境变量和配置说明
docs/TECHNICAL_REFERENCE.md - 更新配置参考
.env.example - 添加新的环境变量示例

🏗️ 架构变更 (refactor/architecture)

docs/ARCHITECTURE.md - 更新系统架构图和组件说明
docs/TECHNICAL_REFERENCE.md - 更新技术实现细节
CONTRIBUTING.md - 更新开发指南（如影响开发流程）

🧪 测试相关 (test)

docs/TECHNICAL_REFERENCE.md - 更新测试部分
CONTRIBUTING.md - 更新测试指南

📚 依赖变更 (deps)

docs/GETTING_STARTED.md - 更新安装要求
CONTRIBUTING.md - 更新开发环境设置

🔌 新的集成/提供者 (integration)

docs/TECHNICAL_REFERENCE.md - 添加新提供者文档
docs/GETTING_STARTED.md - 添加配置指南
docs/ARCHITECTURE.md - 更新架构图

3. 系统性文档更新流程

A. 核心文档更新

README.md / README_zh.md

检查项目描述是否准确
更新功能列表和主要特性
验证快速开始部分的准确性
更新示例代码和用法
检查徽章和链接是否有效

docs/GETTING_STARTED.md

更新安装说明（如有新依赖）
添加新的配置选项
更新环境变量说明
添加新功能的使用示例
更新故障排除的常见问题

docs/TECHNICAL_REFERENCE.md

添加新的技术实现细节
更新API参考（如有变更）
添加新的搜索提供者文档
更新配置参考表
添加性能优化建议

B. 专项文档更新

docs/ARCHITECTURE.md

更新系统架构图（使用mermaid）
添加新组件的说明
更新数据流图
更新技术实现部分

CONTRIBUTING.md

更新开发环境设置
添加新的编码标准
更新测试指南
添加新的工具或流程

docs/TROUBLESHOOTING.md

添加新发现的问题和解决方案
更新错误代码说明
添加性能问题排查
更新调试技巧

C. 支持文档更新

CHANGELOG.md

添加版本变更记录
按类型分类变更（Added, Changed, Fixed, Removed）
包含破坏性变更说明
添加升级指南（如需要）

Read the full file on GitHub · 342 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

4d ago First seen · 342 lines · 0 tokens per session scan A 98cb6f27a711

Subscribe to this mod's changes

update-full-docs is a command published in the GitHub repository istarwyh/mcpadvisor (89 stars, last pushed 6mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 2,530 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Writing and docs

update-full-docs