MCP Novel Game Server

🚀 MCP Novel Game Server

This repository hosts a game server designed for multi-branched narrative games (visual novels), supporting both English and Japanese versions. It aims to assist users in better understanding MCP (Model Context Protocol) resources. With this server, you can effortlessly run, edit, and add new storylines. The server supports storyline files written in YAML and can be extended by adding your own stories.

How to Create an MCP Server for Visual Novel Games

🚀 Quick Start

✨ Features

• Supports multi-branched storylines for visual novels.
• Available in both English and Japanese versions.
• Allows easy running, editing, and addition of new storylines.
• Supports YAML-written storyline files and can be extended with custom stories.

📦 Installation

1. Install Dependencies

uv sync

2. Run the Server

{
    "novel-game-server": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/username/Documents/projects/mcp-novel-game-server", ## Replace with your project root directory
                "run",
                "src/server.py"
            ]
        }
}

💻 Usage Examples

3. Play the Game or Test Storylines

• Place your storyline files in src/stories/<your_story>/.
• You can select storylines through the server interface or by specifying the storyline ID in the client.

4. Add New Storylines

• Create a new directory under src/stories/ (e.g., villainess_rose or villainess_rose_ja).
• Add a storyline YAML file (refer to existing examples).
• Add a meta.yaml file to describe the storyline.

5. File Structure Example

project-root/
├── src/
│   ├── server.py
│   └── stories/
│       ├── villainess_rose/
│       ├── villainess_rose_ja/
│       └── ...
├── mcp_example.json
├── pyproject.toml
└── README.md

📚 Documentation

Important Notes

• Use uv as the package manager and running tool.
• Storylines can be written in either English or Japanese.
• Refer to src/stories/README.md for details about the storyline tree.

⚠️ Important Note

In the Cline environment, everything can be used directly. In other environments (such as Claude Desktop and Cursor), please use server_tool.py to correctly start and manage the server.