mcp-novel-game

This MCP server hosts a visual novel style storytelling environment with multi-branch scenarios written in YAML. It supports English and Japanese scenarios and exposes a simple interface to select and play scenarios via the server UI or client. The repository demonstrates using the uv package manager to run the server, with the server script located at src/server.py. You can add new stories under src/stories and control the narrative flow by editing or adding YAML scenario files (and optional meta.yaml for metadata).

Prerequisites:

• Python environment available on your system
• uv (the MCP package manager/runner) installed and accessible in your PATH
• Basic familiarity with YAML for creating scenarios

Installation steps:

1. Install uv if you don’t have it yet. Documentation in your environment provider is helpful; the project uses uv sync to install dependencies.

2. Clone or download the repository to your local machine.

3. Install dependencies via uv (as the README suggests):

uv sync

4. Start the server using the provided configuration shown in the README, for example:

uv --directory /path/to/mcp-novel-game-server run src/server.py

5. Open the server interface in your browser or connect via your MCP client and begin loading scenarios from src/stories/.

Note: On certain environments, you may need to use server_tool.py to launch and manage the server as described in the repository notes.

Tips and notes:

• The server expects scenario files under src/stories, organized per story (e.g., villainess_rose/).
• Scenarios can be English or Japanese; ensure metadata and YAML content reflect the target language.
• If you encounter environment-specific issues, refer to the README’s notes about using server_tool.py in non-Cline environments.
• The example mcp_config uses an absolute path for the --directory option; replace it with your actual project root when deploying.
• No additional environment variables are mandatory for a basic run, but you may extend env in mcp_config as needed for your deployment ([[VAR_NAME]] placeholders).
• The server file path is src/server.py; ensure this path exists and is accessible when starting the server.