Kanka MCP - Model Context Protocol Server for Kanka API

Kanka MCP - Model Context Protocol Server for Kanka API

site icon
2025.04.29 0
Python世界构建项目管理内容生成
Kanka MCP 是一个为 Kanka API 提供的模型上下文协议服务器,主要用于与 Kanka 世界构建项目中的各种元素进行交互。它允许 AI 助手管理战役、角色、地点、帖子、笔记和日志。
View on GitHub

Overview

基本能力

产品定位

Kanka MCP 是一个为 Kanka API 提供的模型上下文协议服务器,主要用于与 Kanka 世界构建项目中的各种元素进行交互。

核心功能

  • 战役管理:列出用户的所有战役
  • 角色管理:列出、检索、创建、更新和删除角色
  • 地点管理:列出、检索、创建、更新和删除地点
  • 帖子管理:列出、检索、创建、更新和删除任何实体的帖子
  • 笔记管理:列出、检索、创建、更新和删除笔记
  • 日志管理:列出、检索、创建、更新和删除日志

适用场景

  • 世界构建项目的管理
  • AI 助手与 Kanka 项目的交互

工具列表

  • show_campaigns(): 列出用户有权访问的所有战役
  • list_characters(campaign_id): 列出战役中的所有角色
  • get_character(campaign_id, character_id): 通过 ID 获取特定角色
  • create_character(campaign_id, name, ...): 创建新角色
  • update_character(campaign_id, character_id, ...): 更新现有角色
  • delete_character(campaign_id, character_id): 删除角色
  • list_locations(campaign_id): 列出战役中的所有地点
  • get_location(campaign_id, location_id): 通过 ID 获取特定地点
  • create_location(campaign_id, name, ...): 创建新地点
  • update_location(campaign_id, location_id, ...): 更新现有地点
  • delete_location(campaign_id, location_id): 删除地点
  • list_posts(campaign_id, entity_id): 列出实体的所有帖子
  • get_post(campaign_id, entity_id, post_id): 通过 ID 获取特定帖子
  • create_post(campaign_id, entity_id, name, ...): 创建新帖子
  • update_post(campaign_id, entity_id, post_id, ...): 更新现有帖子
  • delete_post(campaign_id, entity_id, post_id): 删除帖子
  • list_notes(campaign_id): 列出战役中的所有笔记
  • get_note(campaign_id, note_id): 通过 ID 获取特定笔记
  • create_note(campaign_id, name, ...): 创建新笔记
  • update_note(campaign_id, note_id, ...): 更新现有笔记
  • delete_note(campaign_id, note_id): 删除笔记
  • list_journals(campaign_id): 列出战役中的所有日志
  • get_journal(campaign_id, journal_id): 通过 ID 获取特定日志
  • create_journal(campaign_id, name, ...): 创建新日志
  • update_journal(campaign_id, journal_id, ...): 更新现有日志
  • delete_journal(campaign_id, journal_id): 删除日志

使用教程

使用依赖

  • Python 3.10+

安装教程

  1. 克隆仓库: git clone https://github.com/yourusername/kanka_mcp.git cd kanka_mcp

  2. 安装依赖: pip install requests mcp[cli]

或者如果有 pyproject.toml 文件: pip install .

配置

需要设置 KANKA_API_KEY 环境变量:

export KANKA_API_KEY=your_kanka_api_key

获取 Kanka API 密钥: 1. 登录 Kanka 账户 2. 进入“账户设置” 3. 导航到“API”部分 4. 创建或复制 API 令牌

运行 MCP 服务器

python kanka_mcp.py

添加到 MCP 服务器配置

在 MCP 服务器配置中添加以下内容:

"kanka": {
    "command": "python",
    "args": [
        "FULL_PATH_TO_SCRIPT_FOLDER/kanka_mcp.py"
    ],
    "env": {
        "KANKA_API_KEY": "YOUR_KANKA_API_KEY"
    }
}

替换 FULL_PATH_TO_SCRIPT_FOLDER 为脚本目录的绝对路径,YOUR_KANKA_API_KEY 为实际的 Kanka API 密钥。

常见问题解答

  • 如何获取 Kanka API 密钥? 登录 Kanka 账户,进入“账户设置”中的“API”部分创建或复制 API 令牌。
  • 如何运行服务器? 使用命令 python kanka_mcp.py 运行服务器。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。