MCP Server for Minecraft Mod Documentation
by Zhou-Shilin
This is an MCP server for viewing Minecraft mod development documentation. It currently supports Neoforge documentation and is designed to be extensible to support other documentation sources like Fabric.
Last updated: N/A
What is MCP Server for Minecraft Mod Documentation?
The MCP Server for Minecraft Mod Documentation is a server based on the Model Context Protocol (MCP) that provides access to Minecraft mod development documentation. It allows clients to retrieve documentation for different mod loaders and versions.
How to use MCP Server for Minecraft Mod Documentation?
To use the server, configure an MCP-compatible client (like Claude Desktop or VS Code) to connect to the server. Use the get_providers tool to list available mod loaders and versions. Then, use get_structure to view the document structure and previews. Finally, use get_full_content to retrieve the full content of desired documents.
Key features of MCP Server for Minecraft Mod Documentation
Provides a list of available documentation providers and versions.
Allows viewing the file structure and previews of documentation.
Enables retrieval of the full content of documentation files.
Automatically manages and updates local repositories.
Integrates with MCP-compatible clients.
Use cases of MCP Server for Minecraft Mod Documentation
Looking up specific information about modding APIs in different Minecraft versions.
Understanding how to implement specific features in a mod.
Quickly accessing documentation from within a development environment.
Comparing documentation across different mod loaders (e.g., Neoforge and Fabric).
FAQ from MCP Server for Minecraft Mod Documentation
How do I add a new documentation provider?
How do I add a new documentation provider?
Create a new provider class in the src/mcp_server_minecraft_mod_devdoc/providers/ directory, implementing the DocProvider interface. Then, register the new provider in src/mcp_server_minecraft_mod_devdoc/main.py.
What do I do if I get an 'Error: Failed to read file content' error?
What do I do if I get an 'Error: Failed to read file content' error?
This could be due to Git issues, repository cloning problems, incorrect repository branch, or permission issues. Ensure Git is installed and working, the repository directory exists and contains the correct content, the server is using the correct branch (main or master), and you have permission to read the files.
What do I do if the server fails to start?
What do I do if the server fails to start?
This could be due to dependency issues or port conflicts. Ensure all necessary dependencies are installed (pip install -r requirements.txt) and that the server's default ports are not being used by other applications.
How often does the server update the documentation repositories?
How often does the server update the documentation repositories?
The server automatically updates the local repositories only when necessary, either on first use or if the last update was more than 24 hours ago.
What is MCP?
What is MCP?
MCP stands for Model Context Protocol. It is a protocol that enables tools to communicate with each other and share information about the context in which they are operating. This server uses MCP to provide documentation to MCP-compatible clients.