D&D 5e法术书工具

一个基于Model Context Protocol (MCP)的D&D 5e法术信息查询工具,提供法术搜索、详细信息查看和分类列表功能。

  • by Linell
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 linell/grimoire-mcp

使用说明

魔法书

“世界上最好的MCP驱动的D&D 5e拼写书”

一种模型上下文协议(MCP)服务器,通过一组工具提供D&D5e拼写信息。作为一个学习项目,旨在探索 史密瑟里 MCP部署平台。

特性

  • 使用过滤器进行拼写搜索(级别、学校、班级、姓名、仪式、浓度)
  • 详细的法术信息,包括施法时间、成分和描述
  • 按级别列出特定类别的拼写列表
  • 拼写学校和人物课参考

由D&D 5e API提供动力

该项目完全由 D&D 5e API -一个全面的、社区驱动的API,提供了关于D&D 5e魔法、怪物等的详细信息。

快速开始

先决条件

  • Node.js 18+
  • npm或纱线

安装

  1. 克隆存储库:
git clone https://github.com/yourusername/grimoire.git
cd grimoire
  1. 安装依赖项:
npm install
  1. 启动开发服务器:
npm run dev

可用工具

  • search_spells -使用各种过滤器搜索法术
  • get_spell -获取特定咒语的详细信息
  • list_schools -列出所有可用的D&D 5e拼写学校
  • list_classes -列出所有可用的拼写字符类
  • get_class_spells -获得特定等级的特定职业可用的法术

与Smithery一起建造

此项目部署使用 史密瑟里,一个用于部署MCP服务器的平台,可以轻松地部署、扩展和管理MCP服务器,无需配置。

发展

项目结构

grimoire/
├── src/
│   └── index.ts          # Main MCP server implementation
├── package.json          # Dependencies and scripts
├── smithery.yaml         # Smithery deployment configuration
└── README.md            # This file

地方发展

启动开发服务器:

npm run dev

服务器将在Smithery CLI提供的本地端点上可用。

配置

  • debug (boolean):启用调试日志记录(默认值:false)

贡献

欢迎投稿!这是一个学习项目,所以请随时:

  • 添加新的拼写相关工具
  • 改进错误处理
  • 加强文件编制
  • 添加测试
  • 建议新功能

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢

  • D&D 5e API 用于提供全面的拼写数据
  • 史密瑟里 用于MCP部署平台
  • D&D 5e社区,用于维护全面的游戏数据

链接