Generated banner for Wiki LLMs Txt
Generated logo for Wiki LLMs Txt

Wiki LLMs Txt

MicrosoftOfficialCreated by Microsoft

  • Skill
  • Content generator
  • Documents and content
  • MIT
  • No issues found

From the author

Generates llms.txt and llms-full.txt files for LLM-friendly project documentation following the llms.txt specification. Use when the user wants to create LLM-readable summaries, llms.txt files, or make their wiki accessible to language models.
— the description by Microsoft

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill automates the creation of LLM-friendly documentation files following the llms.txt specification. It scans existing project wikis or documentation to produce a structured discovery file (llms.txt) and a comprehensive, inlined content file (llms-full.txt). By organizing documentation into prioritized sections and providing clear, dense summaries, it ensures that AI agents can efficiently index and understand project architecture, setup guides, and deep-dive technical details.

What it does

  • Generates a standard llms.txt file for project discovery.
  • Creates an llms-full.txt file with inlined documentation content.
  • Organizes documentation links by priority and relevance.
  • Strips YAML frontmatter while preserving diagrams and citations.
  • Validates that all linked documentation files exist and are accessible.
  • Ensures compliance with the official llms.txt specification.

When to use it

  • When you need to make your project documentation accessible to AI agents.
  • When you want to provide a concise summary of your project for LLM context.
  • When you need to bundle documentation into a single file for easier AI ingestion.
  • When you are following the llms.txt standard for your repository.

Advantages

  • Improves AI agent performance by providing structured, relevant context.
  • Reduces token usage by offering both a summary and a full-content version.
  • Maintains consistency across project documentation.
  • Ensures documentation is machine-readable without losing technical diagrams.

Usage examples

“Create an llms.txt file for this project.”
The agent will scan the repository, resolve the source URL, and generate the required llms.txt and llms-full.txt files in the appropriate directories.
“Make my wiki LLM-friendly.”
The agent will organize your existing wiki pages into a structured llms.txt format, ensuring all links are valid and content is properly summarized.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/microsoft/wiki-llms-txt/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip wiki-llms-txt.zip -d .agents/skills

Documentation by Microsoft

llms.txt Generator

Generate llms.txt and llms-full.txt files that provide LLM-friendly access to wiki documentation, following the llms.txt specification.

When This Skill Activates

  • User asks to generate llms.txt or mentions the llms.txt standard

  • User wants to make documentation "LLM-friendly" or "LLM-readable"

  • User asks for a project summary file for language models

  • User mentions llms-full.txt or context-expanded documentation

Source Repository Resolution (MUST DO FIRST)

Before generating, resolve the source repository context:

  1. Check for git remote: Run git remote get-url origin

  2. Ask the user: "Is this a local-only repository, or do you have a source repository URL?"

    • Remote URL → store as REPO_URL

    • Local → use relative paths only

  3. Determine default branch: Run git rev-parse --abbrev-ref HEAD

  4. Do NOT proceed until resolved

llms.txt Format (Spec-Compliant)

The file follows the llms.txt specification:

# {Project Name}

> {Dense one-paragraph summary — what it does, who it's for, key technologies}

{Important context paragraphs — constraints, architectural philosophy, non-obvious things}

## {Section Name}

- [{Page Title}]({relative-path-to-md}): {One-sentence description of what the reader will learn}

## Optional

- [{Page Title}]({relative-path-to-md}): {Description — these can be skipped for shorter context}
Key Rules
  1. H1 — Project name (exactly one, required)

  2. Blockquote — Dense, specific summary (required). Must be unique to THIS project.

  3. Context paragraphs — Non-obvious constraints, things LLMs would get wrong without being told

  4. H2 sections — Organized by topic, each with a list of [Title](url): Description entries

  5. "Optional" H2 — Special meaning: links here can be skipped for shorter context

  6. Relative links — All paths relative to wiki directory

  7. Dynamic — ALL content derived from actual wiki pages, not templates

  8. Section order — Most important first: Onboarding → Architecture → Getting Started → Deep Dive → Optional

Description Quality
❌ Bad✅ Good
"Architecture overview""System architecture showing how Orleans grains communicate via message passing with at-least-once delivery"
"Getting started guide""Prerequisites, local dev setup with Docker Compose, and first API call walkthrough"
"The API reference""REST endpoints with auth requirements, rate limits, and request/response schemas"

llms-full.txt Format

Same structure as llms.txt but with full content inlined:

# {Project Name}

> {Same summary}

{Same context}

## {Section Name}

<doc title="{Page Title}" path="{relative-path}">
{Full markdown content — frontmatter stripped, citations and diagrams preserved}
</doc>
Inlining Rules
  • Strip YAML frontmatter (--- blocks) from each page

  • Preserve Mermaid diagrams — keep ```mermaid fences intact

  • Preserve citations — all [file:line](URL) links stay as-is

  • Preserve tables — all markdown tables stay intact

  • Preserve <!-- Sources: --> comments — these provide diagram provenance

Prerequisites

This skill works best when wiki pages already exist (via /deep-wiki:generate or /deep-wiki:page). If no wiki exists yet:

  1. Suggest running /deep-wiki:generate first

  2. OR generate a minimal llms.txt from README + source code scan (without wiki page links)

Output Files

Generate three files:

FilePurposeDiscoverability
./llms.txtRoot discovery fileStandard path per llms.txt spec. GitHub MCP get_file_contents and search_code find this first.
wiki/llms.txtWiki-relative linksFor VitePress deployment and wiki-internal navigation.
wiki/llms-full.txtFull inlined contentComprehensive reference for agents needing all docs in one file.

The root ./llms.txt links into wiki/ (e.g., [Guide](./wiki/onboarding/contributor-guide.md)). The wiki/llms.txt uses wiki-relative paths (e.g., [Guide](./onboarding/contributor-guide.md)).

If a root llms.txt already exists and was NOT generated by deep-wiki, do NOT overwrite it.

Validation Checklist

Before finalizing:

  • [ ] All linked files in llms.txt actually exist

  • [ ] All <doc> blocks in llms-full.txt have real content (not empty)

  • [ ] Blockquote is specific to this project (not generic boilerplate)

  • [ ] Sections ordered by importance

  • [ ] No duplicate page entries across sections

  • [ ] "Optional" section only contains truly optional content

  • [ ] llms.txt is concise (1-5 KB)

  • [ ] llms-full.txt contains all wiki pages

Files

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Microsoft
Publisher
Microsoft (Official)
Source
microsoft/skills · .github/plugins/deep-wiki/skills/wiki-llms-txt · commit 0696600
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Microsoft or Microsoft.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download wiki-llms-txt.zip