Skip to content

Linell/grimoire-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grimoire

"World's okayest MCP-powered D&D 5e spellbook"

smithery badge

A Model Context Protocol (MCP) server that provides D&D 5e spell information through a set of tools. Built as a learning project to explore the Smithery MCP deployment platform.

Features

  • Spell search with filters (level, school, class, name, ritual, concentration)
  • Detailed spell information including casting time, components, and descriptions
  • Class-specific spell lists by level
  • Spell school and character class references

Powered by D&D 5e API

This project is entirely powered by the D&D 5e API - a comprehensive, community-driven API that provides detailed information about D&D 5e spells, monsters, and more.

Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/grimoire.git
cd grimoire
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

Available Tools

  • search_spells - Search for spells with various filters
  • get_spell - Get detailed information about a specific spell
  • list_schools - List all available D&D 5e spell schools
  • list_classes - List all available spellcasting character classes
  • get_class_spells - Get spells available to a specific class at a given level

Built with Smithery

This project is deployed using Smithery, a platform for deploying MCP servers that makes it easy to deploy, scale, and manage MCP servers with zero configuration.

Development

Project Structure

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

Local Development

Start the development server:

npm run dev

The server will be available at the local endpoint provided by Smithery CLI.

Configuration

  • debug (boolean): Enable debug logging (default: false)

Contributing

Contributions are welcome! This is a learning project, so feel free to:

  • Add new spell-related tools
  • Improve error handling
  • Enhance the documentation
  • Add tests
  • Suggest new features

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • D&D 5e API for providing comprehensive spell data
  • Smithery for the MCP deployment platform
  • The D&D 5e community for maintaining comprehensive game data

Links

About

A D&D 5e spellbook MCP server

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published