MCP Novel Game Server

🚀 MCP 小说游戏服务器

本项目是一个支持多分支故事情节（视觉小说）的游戏服务器，可同时运行英文和日文版本，能帮助您更好地理解 MCP（模型上下文协议）资源。您可以轻松地运行、编辑并添加新的故事情节，服务器支持用 YAML 编写的故事情节文件，可通过添加自己的故事进行扩展。

如何制作 Visual Novel 游戏的 MCP 服务器

🚀 快速开始

安装依赖

uv sync

运行服务器

{
    "novel-game-server": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/username/Documents/projects/mcp-novel-game-server", ## 替换为您的项目根目录
                "run",
                "src/server.py"
            ]
        }
}

玩游戏或测试情节

• 将您的故事情节文件放在 src/stories/<your_story>/ 中
• 您可以通过服务器的界面或在客户端中指定情节 ID 来选择情节

添加新情节

• 在 src/stories/ 下创建新的目录（例如 villainess_rose 或 villainess_rose_ja）
• 添加故事情节 YAML 文件（参见现有示例）
• 添加描述情节的 meta.yaml

文件结构示例

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

✨ 主要特性

• 支持多分支故事情节（视觉小说），可同时运行英文和日文版本。
• 帮助用户更好地理解 MCP（模型上下文协议）资源。
• 可轻松运行、编辑并添加新的故事情节。
• 支持用 YAML 编写的故事情节文件，可通过添加自己的故事进行扩展。

📦 安装指南

安装依赖

uv sync

运行服务器

{
    "novel-game-server": {
            "command": "uv",
            "args": [
                "--directory",
                "/Users/username/Documents/projects/mcp-novel-game-server", ## 替换为您的项目根目录
                "run",
                "src/server.py"
            ]
        }
}

💻 使用示例

基础用法

玩游戏或测试情节

- 将您的故事情节文件放在 `src/stories/<your_story>/` 中
- 您可以通过服务器的界面或在客户端中指定情节 ID 来选择情节

添加新情节

- 在 `src/stories/` 下创建新的目录（例如 `villainess_rose` 或 `villainess_rose_ja`）
- 添加故事情节 YAML 文件（参见现有示例）
- 添加描述情节的 `meta.yaml`

📚 详细文档

注意事项

⚠️ 重要提示

• 使用 uv 作为包管理器和运行工具。
• 情节可以用英文或日文编写。
• 有关情节树和详细信息，请参阅 src/stories/README.md。

💡 使用建议

在 Cline 环境下，一切都可以直接使用。在其他环境（如 Claude Desktop 和 Cursor），请使用 server_tool.py 来正确启动和管理服务器。