Minecraft Plugin Documentation MCP Server
Minecraft 插件文档 MCP 服务器
一个 MCP (Model Context Protocol) 服务器,旨在帮助 Minecraft Java 插件开发者查看常用依赖项的最新文档和版本。
功能特性
依赖项文档查询 - 获取主流 Minecraft 插件依赖项的维基、Javadoc 和 GitHub 链接
项目扫描 - 扫描 Gradle 和 Maven 项目以提取所有依赖项
版本检查 - 从 Maven Central、JitPack、Paper 仓库等处检查最新版本
完整项目分析 - 对插件工作区进行全面分析并提供建议
API 参考 - 针对复杂插件(如 EdTools、SkinsRestorer 等)提供详细的子 API 文档
Related MCP server: MCP Discord
支持的依赖项
依赖项 | 仓库 | 描述 |
Paper API | Paper | Paper Minecraft 服务器 API |
Spigot API | Spigot | Spigot Minecraft 服务器 API |
Bukkit | Spigot | Bukkit API |
LuckPerms | Maven Central | 权限插件 API |
Vault | JitPack | 经济/权限/聊天 API |
HikariCP | Maven Central | JDBC 连接池 |
Item-NBT-API | CodeMC | 无需 NMS 的 NBT 操作 |
PacketEvents | Maven Central | 数据包操作库 |
DecentHolograms | JitPack | 全息图插件 API |
CoreProtect | Maven Central | 方块记录 API |
mc-MenuAPI | JitPack | GUI/菜单 API |
PlaceholderAPI | 自定义 | 占位符系统 |
WorldEdit | 自定义 | 世界编辑 API |
WorldGuard | 自定义 | 区域保护 API |
SkinsRestorer | CodeMC | 皮肤管理 API |
EdTools API | 手动 (JAR) | 自定义附魔、区域、货币等 |
快速入门 - 在项目中使用
选项 1:全局安装(推荐)
全局安装一次 MCP,然后在任何项目中使用:
# Clone and setup (one time only)
git clone https://github.com/ValentinTarnovsky/MCP-MCP.git
cd MCP-MCP
npm install
npm run build
npm link然后在任何项目中,将此内容添加到你的 MCP 配置中:
Claude Code (.claude/mcp.json):
{
"mcpServers": {
"minecraft-plugin-docs": {
"command": "npx",
"args": ["minecraft-plugin-docs-mcp"]
}
}
}Claude Desktop (%APPDATA%\Claude\claude_desktop_config.json):
{
"mcpServers": {
"minecraft-plugin-docs": {
"command": "npx",
"args": ["minecraft-plugin-docs-mcp"]
}
}
}选项 2:直接路径
如果你不想使用 npm link:
{
"mcpServers": {
"minecraft-plugin-docs": {
"command": "node",
"args": ["C:\\path\\to\\MCP-MCP\\dist\\index.js"]
}
}
}使用示例
配置完成后,你可以向 Claude 询问如下内容:
获取依赖项文档
"Get documentation for paper-api"
"Look up luckperms docs"
"What's the Maven coordinate for hikaricp?"
"Show me EdTools API reference"
"How do I use SkinsRestorer API?"扫描你的项目
"Scan dependencies in my project"
"What dependencies does this plugin use?"检查更新
"Check for updates in this project"
"What's the latest version of paper-api?"
"Are my dependencies up to date?"完整分析
"Analyze my plugin workspace"
"Full dependency report"工具参考
get_dependency_docs
获取特定依赖项的文档。
参数 | 必需 | 描述 |
| 是 | 依赖项名称(例如 "paper-api", "edtools") |
| 否 | 是否获取最新版本(默认:true) |
返回: 维基 URL、Javadoc、GitHub、Maven 坐标、快速入门代码片段以及可用的 API 参考。
scan_project_dependencies
扫描项目目录以获取所有依赖项。
参数 | 必需 | 描述 |
| 是 | 项目目录路径 |
check_latest_versions
检查依赖项的最新版本。
参数 | 必需 | 描述 |
| 否 | 扫描当前版本的路径 |
| 否 | 要检查的特定依赖项列表 |
| 否 | 检查所有已知依赖项 |
analyze_plugin_project
包含建议的全面项目分析。
参数 | 必需 | 描述 |
| 否 | 要分析的路径 |
| 否 | 是否检查更新(默认:true) |
添加自定义依赖项
编辑 src/registry/dependencies.ts:
标准 Maven 依赖项
'my-plugin-api': {
name: 'My Plugin API',
description: 'Description here',
documentation: {
wiki: 'https://...',
javadocs: 'https://...',
github: 'https://github.com/...',
},
maven: {
groupId: 'com.example',
artifactId: 'my-plugin-api',
repository: 'maven-central', // or 'jitpack', 'paper', 'codemc', 'custom'
repositoryUrl: 'https://...', // required for 'custom' repos
},
aliases: ['myplugin', 'my-plugin'],
},手动 JAR 依赖项(无 Maven 仓库)
'local-plugin-api': {
name: 'Local Plugin API',
description: 'A plugin that distributes JAR manually',
documentation: {
wiki: 'https://...',
github: 'https://...',
downloadUrl: 'https://download-link...', // Where to get the JAR
},
maven: {
groupId: 'com.example',
artifactId: 'LocalPlugin-API',
repository: 'manual', // Special type for local JARs
},
aliases: ['localplugin'],
// Optional: Document sub-APIs
apiReference: {
mainClass: 'LocalPluginAPI',
importPackage: 'com.example.api',
subApis: [
{
name: 'FeatureAPI',
getter: 'getFeatureAPI()',
description: 'Manage features',
methods: ['doSomething()', 'getSomething() -> String'],
},
],
},
},添加后,重新构建:npm run build
开发
项目结构
MCP-MCP/
├── src/
│ ├── index.ts # Main server entry point
│ ├── registry/
│ │ └── dependencies.ts # Dependency information registry
│ ├── parsers/
│ │ ├── gradle.ts # Gradle build file parser
│ │ └── maven.ts # Maven POM parser
│ ├── tools/
│ │ ├── getDependencyDocs.ts
│ │ ├── scanProjectDependencies.ts
│ │ ├── checkLatestVersions.ts
│ │ └── analyzePluginProject.ts
│ └── utils/
│ ├── cache.ts # Caching utilities
│ └── versionFetcher.ts # Version fetching from repos
├── dist/ # Compiled output
├── package.json
├── tsconfig.json
└── README.md命令
npm install # Install dependencies
npm run build # Compile TypeScript
npm run dev # Watch mode for development
npm run clean # Remove dist/
npm link # Make available globally via npx测试
# Run the server manually
node dist/index.js
# Test with MCP Inspector
npx @modelcontextprotocol/inspector node dist/index.js故障排除
服务器无法启动
确保已安装 Node.js 18+:
node --version检查构建是否完成:
npm run build验证
dist/index.js是否存在
找不到依赖项
检查依赖项名称的拼写
尝试使用别名(例如 "paper" 而不是 "paper-api")
使用 Maven 坐标(例如 "io.papermc.paper:paper-api")
找不到 npx 命令
在 MCP-MCP 目录中运行
npm link使用
npm list -g minecraft-plugin-docs-mcp进行验证
许可证
MIT
贡献
Fork 本仓库
创建功能分支
添加你的更改
提交 Pull Request
致谢
Model Context Protocol - MCP 规范
PaperMC - Paper Minecraft 服务器
SpigotMC - Spigot Minecraft 服务器
Available Tools
4 toolsanalyze_plugin_projectB
Perform a comprehensive analysis of a Minecraft plugin project or workspace. Scans all subprojects, extracts dependencies, checks for updates, and provides recommendations.
| Name | Required | Description | Default |
|---|---|---|---|
| project_path | No | Path to the project or workspace directory. Defaults to "C:\Users\tarno\Desktop\OkiMC-Plugins" if not provided. | |
| check_versions | No | Whether to check for latest versions of dependencies (default: true) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions scanning, extracting, checking, and recommending, but lacks details on permissions required, whether it modifies files, rate limits, output format, or error handling. For a tool with potential file system access and analysis operations, this leaves significant behavioral gaps.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that front-loads the main purpose and lists key actions without redundancy. It could be slightly more structured by separating core functions, but it avoids waste and is appropriately sized for the tool's scope.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no annotations and no output schema, the description provides a basic overview but lacks completeness for a tool with file system interaction and analysis outputs. It covers the 'what' but not the 'how' or 'what next', such as result format or error cases, leaving gaps in contextual understanding despite the clear schema coverage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both parameters thoroughly. The description adds no additional parameter semantics beyond implying 'project_path' is for analysis and 'check_versions' relates to dependency updates, which the schema already covers. Baseline 3 is appropriate when schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool performs a 'comprehensive analysis' of a Minecraft plugin project, specifying actions like scanning subprojects, extracting dependencies, checking for updates, and providing recommendations. It distinguishes from siblings by covering multiple analysis aspects rather than focusing on specific tasks like version checking or documentation retrieval, though it doesn't explicitly contrast with each sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for analyzing plugin projects with dependency and update concerns, but provides no explicit guidance on when to use this tool versus alternatives like 'check_latest_versions' or 'scan_project_dependencies'. It suggests a broad analysis context without detailing prerequisites, exclusions, or comparative scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
check_latest_versionsA
Check for the latest versions of Minecraft plugin dependencies. Can check all known dependencies or compare against project's current versions.
| Name | Required | Description | Default |
|---|---|---|---|
| project_path | No | Optional path to a project directory. If provided, will scan the project and check versions against current dependencies. | |
| dependencies | No | Optional list of specific dependencies to check with their current versions. | |
| check_all | No | If true, checks latest versions for all known Minecraft plugin dependencies (default: false) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden of behavioral disclosure. It describes what the tool does but lacks details on behavioral traits such as whether it requires network access, how it handles errors, if there are rate limits, or what the output format looks like. This is a significant gap for a tool that likely interacts with external resources.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded and concise, consisting of two sentences that efficiently convey the tool's purpose and usage modes without any wasted words. Every sentence earns its place by providing essential information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of checking dependencies (which may involve external APIs or repositories) and the lack of annotations and output schema, the description is incomplete. It does not cover behavioral aspects like network requirements, error handling, or output structure, leaving gaps that could hinder an AI agent's ability to use the tool effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description mentions the two modes (checking all or comparing against a project) which aligns with the parameters 'check_all' and 'project_path', but it does not add meaning beyond what the input schema provides. Since schema description coverage is 100%, the baseline score is 3, as the schema already documents all parameters adequately.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the specific action ('check for the latest versions') and resource ('Minecraft plugin dependencies'), and distinguishes between two modes: checking all known dependencies or comparing against a project's current versions. This specificity helps differentiate it from sibling tools like 'analyze_plugin_project' or 'scan_project_dependencies'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context for when to use the tool: either to check all known dependencies or to compare against a project's current versions. However, it does not explicitly state when not to use it or name alternatives among sibling tools, which would be needed for a perfect score.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dependency_docsA
Get documentation URLs, Maven coordinates, and latest version for a Minecraft plugin dependency. Returns wiki, javadocs, GitHub links, and quick-start code snippets.
| Name | Required | Description | Default |
|---|---|---|---|
| dependency | Yes | Name of the dependency (e.g., "paper-api", "luckperms", "vault", "hikaricp") | |
| fetch_version | No | Whether to fetch the latest version (default: true) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It describes the return content (URLs, coordinates, version, links, snippets), which is helpful, but doesn't mention potential limitations like rate limits, authentication needs, error handling, or whether it's a read-only operation. It adds some context but lacks comprehensive behavioral details for a tool with no annotation coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, well-structured sentence that efficiently conveys the tool's purpose and return values without unnecessary words. It's front-loaded with the core action and resource, making it easy to parse quickly. Every part of the sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's moderate complexity (2 parameters, no output schema, no annotations), the description is reasonably complete. It explains what the tool does and what it returns, which is sufficient for a read operation. However, without annotations or output schema, it could benefit from more behavioral details like response format or error cases, but it's largely adequate for its purpose.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already fully documents both parameters ('dependency' and 'fetch_version'). The description doesn't add any parameter-specific details beyond what's in the schema, such as examples of dependency formats or implications of the fetch_version setting. Baseline 3 is appropriate when the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Get') and the specific resources ('documentation URLs, Maven coordinates, and latest version for a Minecraft plugin dependency'), including what information is returned ('wiki, javadocs, GitHub links, and quick-start code snippets'). It distinguishes itself from sibling tools like 'analyze_plugin_project' or 'scan_project_dependencies' by focusing on dependency documentation rather than project analysis or version checking.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when documentation for a Minecraft plugin dependency is needed, but it doesn't explicitly state when to use this tool versus alternatives like 'check_latest_versions' (which might focus only on versions) or 'scan_project_dependencies' (which might list dependencies without documentation). There's no guidance on prerequisites or exclusions, leaving usage context somewhat vague.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
scan_project_dependenciesA
Scan a Minecraft plugin project directory and extract all dependencies from build.gradle, build.gradle.kts, and pom.xml files. Returns a structured list of dependencies with version info.
| Name | Required | Description | Default |
|---|---|---|---|
| project_path | Yes | Path to the project directory to scan |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden. It describes the core operation but lacks important behavioral details: whether the scan is recursive, what happens if files are missing or malformed, whether it modifies files, error handling, or performance characteristics. The description doesn't contradict annotations (none exist), but provides minimal behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences that efficiently convey purpose and outcome with zero wasted words. The first sentence states what the tool does, the second describes the return value. Perfectly front-loaded and appropriately sized for the complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter tool with no annotations and no output schema, the description adequately covers the basic operation but lacks completeness. It doesn't explain the structure of the returned dependency list, error conditions, or important behavioral constraints. The description compensates somewhat but leaves significant gaps for a tool that performs file system operations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% (the single parameter 'project_path' is fully documented in the schema). The description doesn't add any parameter-specific information beyond what the schema provides, such as path format expectations or validation rules. With high schema coverage, baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the specific action ('scan', 'extract'), the target resource ('Minecraft plugin project directory'), and the specific files processed ('build.gradle, build.gradle.kts, and pom.xml files'). It distinguishes from siblings by focusing on dependency extraction rather than analysis, version checking, or documentation retrieval.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage context (when you need to extract dependencies from specific build files), but doesn't explicitly state when to use this tool versus alternatives like 'analyze_plugin_project' or 'check_latest_versions'. No exclusions or prerequisites are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
4 tool updates
v1.0.1- First observed
analyze_plugin_project - First observed
check_latest_versions - First observed
get_dependency_docs - First observed
scan_project_dependencies
TDQS
Scored across 4 tools
The tools have mostly distinct purposes with clear boundaries: analyze_plugin_project focuses on comprehensive project analysis, check_latest_versions handles version checking, get_dependency_docs retrieves documentation, and scan_project_dependencies extracts dependency lists. However, analyze_plugin_project and scan_project_dependencies have some overlap in scanning dependencies, which could cause minor confusion.
All tool names follow a consistent verb_noun pattern with snake_case throughout: analyze_plugin_project, check_latest_versions, get_dependency_docs, and scan_project_dependencies. The naming is predictable and readable without any deviations or mixed conventions.
With 4 tools, the count is reasonable for a server focused on Minecraft plugin documentation and dependency management. It covers key areas like analysis, version checking, documentation retrieval, and dependency scanning, though it might feel slightly thin for broader plugin development workflows.
The tool set covers core aspects of dependency management and documentation for Minecraft plugins, but there are notable gaps. It lacks tools for creating or updating dependencies, managing plugin configurations, or integrating with development environments, which could limit agent workflows in more complex scenarios.
Maintenance
Related MCP Connectors
Official MCP server for twitterapis.com. Read and write Twitter/X: search, users, tweets, DMs.
MCP server for developer documentation, generated by doc2mcp.
MCP registry & directory: search, find & install 31k+ MCP servers & tools. Catalog and marketplace.
A MCP server built for developers enabling Git based project management with project and personal…
Related MCP Servers
- AlicenseAqualityCmaintenanceAn MCP server designed for developers to build and manage Minestom-based Minecraft servers by inspecting project environments, build configurations, and API documentation. It enables users to plan features, review design patterns, and discover libraries within the Minestom ecosystem.96 npm6Apache 2.0
- AlicenseNot gradedqualityCmaintenanceThe most complete open-source MCP server for Discord — 80+ tools, dual-mode: integrated (plugin) or standalone38 npm14MIT
- AlicenseNot gradedqualityBmaintenanceDependency Updater AI - MCP server providing AI-powered tools and automation by MEOK AI Labs10 npm81 PyPIMIT
- AlicenseNot gradedqualityDmaintenanceAn MCP server for EndstoneMC development, enabling module information queries, code search, plugin template generation, event handling guidance, and development tutorials through natural language.2MIT