A MCP-based Minecraft Wiki server providing convenient access to Minecraft Wiki content via stdio, SSE and HTTP
Project description
Minecraft Wiki MCP Server
Project Overview
A MCP-based Minecraft Wiki server that provides convenient access to Chinese Minecraft Wiki content. Supports stdio, SSE and http transports in a single package, and can be deployed quickly via uvx.
Note: This project only provides the MCP layer on top of a Minecraft wiki API. For local API deployment, please visit minecraft-wiki-fetch-api.
Features
- 🔍 Wiki Search: Search Chinese Minecraft Wiki pages with concise keyword guidance
- 📄 Page Retrieval: Get full page content in wikitext (default, token-efficient) or html
- ✅ Page Existence Check: Quick check if a page exists (including redirects)
- 📚 Namespace Listing: List available wiki namespaces for targeted search
- 🏥 Health Monitoring: Monitor backend Wiki API service status
- 🔌 Multi Transport:
stdio(Claude Desktop / local clients),http(remote/server),sse(legacy) - 🚀 One-Click Deployment: Run via
uvxwithout local install - ⚙️ Env + CLI Config: Flexible configuration via environment variables and CLI flags
Quick Start
🚀 Recommended: Using uvx
# stdio (default) — for Claude Desktop / local MCP clients
uvx mc-wiki-fetch-mcp
# http — for remote / server deployment
uvx mc-wiki-fetch-mcp --transport http --host 0.0.0.0 --port 3001
# Custom Wiki API URL
uvx mc-wiki-fetch-mcp --api-url http://localhost:3000
# Or via environment variables
MC_WIKI_API_BASE_URL=http://localhost:3000 \
MC_WIKI_MCP_TRANSPORT=http \
uvx mc-wiki-fetch-mcp
# Help
uvx mc-wiki-fetch-mcp --help
💻 Integration with Claude Desktop (stdio)
-
Config file locations:
- Windows:
%APPDATA%\Claude\claude_desktop_config.json - macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Linux:
~/.config/claude/claude_desktop_config.json
- Windows:
-
Edit configuration:
{ "mcpServers": { "minecraft-wiki": { "command": "uvx", "args": ["mc-wiki-fetch-mcp"], "env": { "MC_WIKI_API_BASE_URL": "https://mcwiki.rice-awa.top" } } } }
-
Restart Claude Desktop
🌐 Remote / HTTP clients (http)
uvx mc-wiki-fetch-mcp -t http --host 0.0.0.0 --port 3001
Then point your MCP client to http://<host>:3001/mcp (default /mcp path of the MCP Python SDK).
Configuration Options
Environment Variables
| Environment Variable | Description | Default |
|---|---|---|
MC_WIKI_API_BASE_URL / API_BASE_URL |
Wiki API base URL | https://mcwiki.rice-awa.top |
MC_WIKI_API_TIMEOUT |
API request timeout (seconds) | 60 |
MC_WIKI_MCP_TRANSPORT |
Transport: stdio / sse / http |
stdio |
MC_WIKI_MCP_HOST |
Bind host (HTTP/SSE) | 0.0.0.0 |
MC_WIKI_MCP_PORT |
Bind port (HTTP/SSE) | 3001 |
MC_WIKI_MCP_NAME |
MCP server display name | Minecraft Wiki |
MC_WIKI_LOG_LEVEL |
Log level | INFO |
Command Line Arguments
| Parameter | Description |
|---|---|
--transport, -t |
stdio / sse / http |
--host |
Bind host for HTTP/SSE |
--port, -p |
Bind port for HTTP/SSE |
--api-url |
Wiki API base URL |
--timeout |
API request timeout (seconds) |
--log-level |
DEBUG / INFO / WARNING / ERROR / CRITICAL |
--name |
MCP server display name |
--version |
Show version |
--help |
Show help |
Priority: CLI args > environment variables > defaults.
Available Tools
| Tool | Description | Main Parameters |
|---|---|---|
search_wiki |
Search Chinese Minecraft Wiki | q, limit, namespaces |
get_page |
Get page content (wikitext/html) | pageName, format, useCache, includeMetadata |
check_page_exists |
Check whether a page exists | pageName |
check_health |
Check Wiki API health | — |
list_namespaces |
List wiki namespace ID → name map | — |
Tips for Agents
- Prefer 1–3 game terms in
search_wiki; extra keywords narrow results. - Prefer wikitext for
get_page(default). Usehtmlonly when a template is unreadable. - Unknown
{{Template}}in wikitext → callsearch_wikiwithnamespaces=[10].
Traditional Installation (Developers)
git clone <repository-url>
cd mc-wiki-mcp-pypi
pip install -e .
# or: uv pip install -e .
# stdio
mc-wiki-fetch-mcp
# http
mc-wiki-fetch-mcp -t http -p 3001
Troubleshooting
uvx not found
curl -LsSf https://astral.sh/uv/install.sh | sh
# or
pip install uv
Cannot connect to Wiki API
echo $MC_WIKI_API_BASE_URL
curl http://your-api-url/health
MC_WIKI_LOG_LEVEL=DEBUG uvx mc-wiki-fetch-mcp
Tools not visible in Claude Desktop
- Confirm
uvx mc-wiki-fetch-mcp --versionworks - Check Claude Desktop logs
- Restart Claude Desktop
Related Documentation
- API Documentation — Detailed API interface documentation
- Modification Summary — Recent packaging changes
Contributing
Issues and Pull Requests are welcome!
License
MIT License — see LICENSE.
Getting Help
- Check the troubleshooting section above
- Browse docs/
- Open an Issue with logs
Quick tips
- 🚀 Local client:
uvx mc-wiki-fetch-mcp(stdio) - 🌐 Server mode:
uvx mc-wiki-fetch-mcp -t http -p 3001 - ⚙️ Configure: env vars or CLI flags
- 🔧 Develop:
pip install -e .
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mc_wiki_fetch_mcp-0.5.0.tar.gz.
File metadata
- Download URL: mc_wiki_fetch_mcp-0.5.0.tar.gz
- Upload date:
- Size: 50.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
453343d6567a4fdeec4950847137b1ba1d1eb80434fc3e2a48fa801677feef59
|
|
| MD5 |
a69235e60f73bcf4a4653cd9be539ce9
|
|
| BLAKE2b-256 |
48c8170750907ae22971defde6264a8ee12ea78c8be3f55cc67d9b6ce0dd1e1c
|
Provenance
The following attestation bundles were made for mc_wiki_fetch_mcp-0.5.0.tar.gz:
Publisher:
publish.yml on rice-awa/mc-wiki-mcp-pypi
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mc_wiki_fetch_mcp-0.5.0.tar.gz -
Subject digest:
453343d6567a4fdeec4950847137b1ba1d1eb80434fc3e2a48fa801677feef59 - Sigstore transparency entry: 2215097534
- Sigstore integration time:
-
Permalink:
rice-awa/mc-wiki-mcp-pypi@b201e3f6cdfb508542639b1ab0377e42dd75ef89 -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/rice-awa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b201e3f6cdfb508542639b1ab0377e42dd75ef89 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mc_wiki_fetch_mcp-0.5.0-py3-none-any.whl.
File metadata
- Download URL: mc_wiki_fetch_mcp-0.5.0-py3-none-any.whl
- Upload date:
- Size: 11.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6ccfc9919c868065930fda2d6b2d1919fbc7148ce7ff6fd5720c9f118c99bef0
|
|
| MD5 |
ed70d86dd2a514bfb5c50f1406383f51
|
|
| BLAKE2b-256 |
a16599f6145fa7c0acef3fe76130179666ab31f73b897bc17b6de59b59e5d494
|
Provenance
The following attestation bundles were made for mc_wiki_fetch_mcp-0.5.0-py3-none-any.whl:
Publisher:
publish.yml on rice-awa/mc-wiki-mcp-pypi
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mc_wiki_fetch_mcp-0.5.0-py3-none-any.whl -
Subject digest:
6ccfc9919c868065930fda2d6b2d1919fbc7148ce7ff6fd5720c9f118c99bef0 - Sigstore transparency entry: 2215097564
- Sigstore integration time:
-
Permalink:
rice-awa/mc-wiki-mcp-pypi@b201e3f6cdfb508542639b1ab0377e42dd75ef89 -
Branch / Tag:
refs/tags/v0.5.0 - Owner: https://github.com/rice-awa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b201e3f6cdfb508542639b1ab0377e42dd75ef89 -
Trigger Event:
push
-
Statement type: