generate-project-documentation

generate-project-documentation is a skill for Claude Code, Codex from jmrplens/gitlab-mcp-server. It costs 43 tokens per session (2,151 once invoked), scanned A, original, MIT.

A workflow for creating complete project documentation from a codebase, including architecture, component, API, setup, and deployment guides.

In plain words
What is it for?
Documenting packages, MCP tools and resources, configuration, onboarding, deployment, dependencies, and data flows with Mermaid diagrams.
Why use it?
It turns source-code analysis into organized documentation that developers can use without prior project context.

Skill for Claude CodeCodex

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 skills/jmrplens/gitlab-mcp-server/generate-project-documentation
Any agent
npx skills add jmrplens/gitlab-mcp-server --skill generate-project-documentation
Clone the repo
git clone --depth 1 https://github.com/jmrplens/gitlab-mcp-server

Made for: Claude Code, Codex.

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.

agentmods badge for generate-project-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/jmrplens/gitlab-mcp-server/generate-project-documentation.svg)](https://agentmods.dev/skills/jmrplens/gitlab-mcp-server/generate-project-documentation)
Your own site
<a href="https://agentmods.dev/skills/jmrplens/gitlab-mcp-server/generate-project-documentation"><img src="https://agentmods.dev/badge/skills/jmrplens/gitlab-mcp-server/generate-project-documentation.svg" alt="Measured on agentmods" height="20"></a>
Per session 43 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,151 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.

ModelPer sessionOnce invoked
Fable 5 $0.00043 $0.02151
Opus 5 $0.00022 $0.01076
Sonnet 5 $0.00009 $0.00430
Haiku 4.5 $0.00004 $0.00215

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

Security

Grade A, and why

generate-project-documentation 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 5d 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.

.github/skills/generate-project-documentation/SKILL.md · 284 lines

How it starts

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

Generate Project Documentation

Primary Directive

Generate comprehensive, well-organized documentation for the project. Analyze the entire codebase and produce a complete documentation suite covering architecture, components, APIs, developer guides, and deployment configuration.

The documentation must be:

  • Accurate (absolute parity with source code)
  • Organized (Diátaxis framework: Tutorials, How-to, Reference, Explanation)
  • Navigable (index with cross-references between documents)
  • Visual (Mermaid diagrams for architecture and data flow)
  • Self-contained (no external context required to understand)

Execution Context

This skill is designed for the Documentation Writer agent or any agent tasked with producing project documentation. All output must be in English per the project language policy.

Analysis Phase

Before generating any documentation, complete a thorough analysis:

Step 1: Repository Structure Discovery

  1. Explore the complete project directory structure
  2. Identify all Go packages and their responsibilities
  3. Map the dependency graph between internal packages
  4. Locate existing documentation and assess gaps
  5. List all configuration files, build scripts, and CI/CD pipelines

Step 2: Architecture Understanding

  1. Read the entry point (cmd/server/main.go) to understand initialization flow
  2. Identify the configuration loading mechanism
  3. Map how the GitLab client is initialized and injected
  4. Understand the MCP server setup and tool registration pattern
  5. Trace a complete request flow from MCP client to GitLab API and back

Step 3: API Surface Inventory

  1. List all MCP tools with their input/output types
  2. List all MCP resources with their URI templates
  3. List all MCP prompts with their parameters
  4. Document pagination patterns and shared types
  5. Identify tool annotations (readOnlyHint, destructiveHint, etc.)

Step 4: Gap Analysis

  1. Compare current documentation against the coverage matrix below
  2. Identify missing, outdated, or incomplete documentation
  3. Prioritize generation of missing critical documentation first

Read the full file on GitHub · 284 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.

  1. 5d ago First seen · 284 lines · 43 tokens per session scan A 589355d136f8

Subscribe to this mod's changes

generate-project-documentation is a skill published in the GitHub repository jmrplens/gitlab-mcp-server (33 stars, last pushed yesterday), licensed MIT. It adds 43 tokens to every session and 2,151 once invoked, about $0.0002 per session on Opus 5. 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.

Related

Other skills, from other repositories

latex-compile

Compile a LaTeX document and fix every error plus aesthetic issue (overfull/underfull boxes, widows, alignment, fonts) for a clean PDF and log. Use this instead of running pdflatex/latexmk manually — it avoids the latexmk stale-log trap and silent grep failures on binary log output, and it reformats rather than…

Mexregkan/claude-for-researchers · 79 tokens

sync-brief

Propagate load-bearing changes from workbook.tex to brief.tex.

Mexregkan/claude-for-researchers · 0 tokens

llm-docs-generator

Operating playbook for generating and maintaining version-pinned documentation packs with the llm-docs CLI. Use when building, refreshing, or verifying an agent-ready docs pack for a specific installed library version, or when maintaining this repository.

Zyepher/llm-docs-generator · 52 tokens

python-executor

Execute Python code in a safe sandboxed environment via inference.sh. Pre-installed: NumPy, Pandas, Matplotlib, requests, BeautifulSoup, Selenium, Playwright, MoviePy, Pillow, OpenCV, trimesh, and 100+ more libraries. Use for: data processing, web scraping, image manipulation, video creation, 3D model processing, PDF…

CarlosVallejoRuiz/slurp · 128 tokens

doc-coauthoring

Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers.…

DataCovey/nornweave · 77 tokens

docx

Use this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files). Triggers include: any mention of 'Word doc', 'word document', '.docx', or requests to produce professional documents with formatting like tables of contents, headings, page numbers, or letterheads. Also use when…

MRWillisT/PullNexus · 168 tokens