Back to Directory/Documentation

io.github.kcw2034/maplestory-mcp-server

MCP server for Nexon MapleStory OpenAPI - character, rankings, union, guild, and notices

DocumentationPythonv1.0.1

MapleStory MCP Server

An MCP (Model Context Protocol) server that wraps the Nexon MapleStory OpenAPI, allowing AI assistants to query MapleStory game data including character info, rankings, union, guild, and more.

Features

  • Character - Basic info, stats, equipment, skills, V/HEXA matrix, Dojang records
  • Union - Union level, raider layout, artifact info
  • Guild - Guild search and basic info
  • Ranking - Overall, union, guild, Dojang, The Seed, achievement rankings
  • History - Starforce, cube, potential re-roll history
  • Notice - Official notices, updates, events, cash shop notices

Prerequisites

Installation

# Clone the repository
git clone https://github.com/kcw2034/maplestory-mcp-server.git
cd maplestory-mcp-server

# Install dependencies
uv sync

Configuration

Create a .env file in the project root:

MAPLESTORY_API_KEY=your_api_key_here

You can get an API key by registering an app at Nexon OpenAPI.

Usage

Running the server

uv run server.py

Claude Desktop configuration

Add this to your Claude Desktop config (claude_desktop_config.json):

{
  "mcpServers": {
    "maplestory": {
      "command": "uv",
      "args": ["run", "server.py"],
      "cwd": "/path/to/maplestory-mcp-server",
      "env": {
        "MAPLESTORY_API_KEY": "your_api_key_here"
      }
    }
  }
}

Available Tools

CategoryToolDescription
Characterget_character_ocidLook up character OCID by name
Characterget_character_basicBasic info (level, class, world, guild)
Characterget_character_statCombined stats (STR, DEX, combat power)
Characterget_character_item_equipmentEquipped items
Characterget_character_skillSkill info by grade
Characterget_character_hexamatrixHEXA matrix (6th job skills)
Unionget_unionUnion level and grade
Unionget_union_raiderUnion raider layout and effects
Guildget_guild_idLook up guild ID by name and world
Guildget_guild_basicGuild basic info
Rankingget_ranking_overallOverall ranking
Rankingget_ranking_dojangMu Lung Dojang ranking
Historyget_history_starforceStarforce enhancement history
Noticeget_noticesOfficial notice list

See server.py for the full list of 30+ tools.

License

MIT

Installation

Source-derived launch command. Check the maintainer’s required arguments and credentials before running:

bash
uvx maplestory-mcp-server

Set up in your AI client

Merge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.

json
{
  "mcpServers": {
    "io-github-kcw2034-maplestory-mcp-server": {
      "command": "uvx",
      "args": [
        "maplestory-mcp-server"
      ]
    }
  }
}

Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.

Claude Desktop setup reference

Package

maplestory-mcp-serverpypi

Compatible MCP Clients

io.github.kcw2034/maplestory-mcp-server works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.

  • Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.
  • Cursor~/.cursor/mcp.jsonRestart Cursor for changes to take effect.
  • VS Code.vscode/mcp.jsonReload VS Code window for changes to take effect.
  • Windsurf~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect.
  • Claude Code.mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.

Learn More