Minecraft MCP Docs

minecraft mcp文档

索引文档 Minecraft MCP服务器.

此存储库包含从官方来源（PaperMC、Bukkit、Minecraft Wiki）自动抓取的文档和插件作者提交的文档。

______________________________________________________________________

存储库结构

sources/
  paper/
    meta.json                  ← scraping metadata & license info
    doc/
      index.json               ← list of all documentation pages
      
.md                ← one file per documentation page
    javadoc/
      index.json               ← list of all Javadoc entries
      .md           ← full class page (priority packages only)
  bukkit/
    meta.json
    doc/
      index.json
      
.md
    javadoc/
      index.json
      .md
  minecraft-wiki/
    meta.json
    doc/
      index.json
      
.md
plugins/
  _template/                   ← copy this to add your plugin
  
/
    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/ 和 index.db 由GitHub Actions自动更新。请勿手动编辑。 仅包含文件 plugins/ 应该由贡献者编辑。

______________________________________________________________________

添加插件文档

1.分叉此存储库

2.复制模板

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

3.填写 meta.json

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

这 mode 字段控制MCP服务器如何显示文档：

• "classic" --面向用户的文档（命令、配置）
• "dev" -开发人员文档（API、事件、挂钩）
• "both" --两种模式

4.把你的文件写在 docs.md

使用Markdown。彻底：

• 所有命令及其权限
• 所有具有默认值的配置选项
• 对于开发插件：事件、API方法、代码示例

5.（可选）添加 scraper.py 用于自动更新

如果您的文档已在线发布，请添加 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.打开拉取请求

标题格式： feat(plugin): add YourPlugin documentation

自动抓取机器人将打开源代码更改的PR——来自人类的插件PR将单独审查。

______________________________________________________________________

许可证

通过提交Pull Request，您确认您有权根据中指定的许可证分发文档 meta.json.

______________________________________________________________________

学分

• PaperMC --CC BY SA 4.0
• SpigotMC/Bukkit --GPL-3.0
• 我的世界Wiki --CC BY-NC-SA 3.0
• 涡流SMP --MCP服务器托管与开发