minecraft-mcp-docs

Indexed documentation for the Minecraft MCP server.

This repository contains documentation automatically scraped from official sources (PaperMC, Bukkit, Minecraft Wiki) and documentation submitted by plugin authors.

Repository structure

sources/
  paper/
    meta.json                  ← scraping metadata & license info
    doc/
      index.json               ← list of all documentation pages
      <page>.md                ← one file per documentation page
    javadoc/
      index.json               ← list of all Javadoc entries
      <ClassName>.md           ← full class page (priority packages only)
  bukkit/
    meta.json
    doc/
      index.json
      <page>.md
    javadoc/
      index.json
      <ClassName>.md
  minecraft-wiki/
    meta.json
    doc/
      index.json
      <page>.md
plugins/
  _template/                   ← copy this to add your plugin
  <plugin-name>/
    meta.json                  ← plugin metadata
    docs.md                    ← plugin documentation
    scraper.py                 ← optional: auto-fetch docs from your site
index.db                       ← SQLite FTS5 search index (auto-generated)

⚠️ sources/ and index.db are updated automatically by GitHub Actions. Do not edit manually.

Only files in plugins/ should be edited by contributors.

Adding your plugin's documentation

1. Fork this repository

2. Copy the template

cp -r plugins/_template plugins/your-plugin-name

3. Fill in meta.json

{
  "name": "YourPlugin",
  "version": "1.2.3",
  "minecraft_versions": ["1.20", "1.21"],
  "homepage": "https://your-site.com",
  "license": "MIT",
  "mode": "classic"
}

The mode field controls how the MCP server surfaces your docs:

• "classic" — user-facing documentation (commands, configuration)
• "dev" — developer documentation (API, events, hooks)
• "both" — both modes

4. Write your documentation in docs.md

Use Markdown. Be thorough:

• All commands and their permissions
• All configuration options with default values
• For dev plugins: events, API methods, code examples

5. (Optional) Add a scraper.py for auto-updates

If your docs are already published online, add a scraper.py:

def scrape() -> str:
    """
    Return the full Markdown content of your documentation.
    Called automatically by the GitHub Actions workflow.
    """
    import requests
    r = requests.get("https://your-site.com/docs.md", timeout=15)
    r.raise_for_status()
    return r.text

6. Open a Pull Request

Title format: feat(plugin): add YourPlugin documentation

The automated scraper bot will open PRs with source changes — plugin PRs from humans will be reviewed separately.

Licenses

| Source | License | |-------------------|------------------| | PaperMC Docs | CC BY-SA 4.0 | | Bukkit Javadoc | GPL-3.0 | | Minecraft Wiki | CC BY-NC-SA 3.0 | | Plugin docs | Per-plugin license |

By submitting a Pull Request, you confirm that you have the right to distribute the documentation under the license specified in meta.json.

Credits

• PaperMC — CC BY-SA 4.0
• SpigotMC / Bukkit — GPL-3.0
• Minecraft Wiki — CC BY-NC-SA 3.0
• Vortex SMP — MCP server hosting & development