Quick Start Guide

Table of contents

  1. Local Development
  2. Deploy to GitHub Pages
  3. Configure MCP Client
    1. Claude Desktop Configuration Location
  4. Next Steps
  5. Troubleshooting
  6. Adding More Content
    1. Add New Encounters
    2. Add New Names
    3. Add New Plot Hooks
    4. Add New Tools

Local Development

  1. Install Dependencies
    bundle install
    
  2. Run Jekyll Locally
    bundle exec jekyll serve
    
  3. View Site Open http://localhost:4000/

Deploy to GitHub Pages

  1. Push to GitHub
    git add .
    git commit -m "Initial commit: TTRPG GM Tools MCP Server"
    git push origin main
    
  2. Enable GitHub Pages
    • Go to repository Settings
    • Navigate to Pages section
    • Source: GitHub Actions (should be auto-detected)
    • The .github/workflows/jekyll.yml will handle deployment
  3. Wait for Deployment
    • Check the Actions tab for build status
    • Once complete, your site will be live at: https://ttrpg-mcp.tedt.org/

Configure MCP Client

Once deployed, add this to your MCP client configuration (e.g., Claude Desktop):

{
  "mcpServers": {
    "ttrpg-gm-tools": {
      "url": "https://ttrpg-mcp.tedt.org/mcp",
      "transport": {
        "type": "http"
      }
    }
  }
}

Claude Desktop Configuration Location

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json

Next Steps

  1. Customize Data: Edit JSON files in data/ to add your own content
  2. Test Locally: Run bundle install && bundle exec jekyll serve from the repo root
  3. Push Changes: Commit and push to automatically redeploy
  4. Expand: Add more tools, resources, or prompts as needed

Troubleshooting

Bundle install fails?

  • Make sure Ruby is installed: ruby --version
  • Try: gem install bundler

Jekyll serve fails?

  • Run: bundle update
  • Check Ruby version (Ruby 3.1+ is typically required for github-pages)

GitHub Pages not deploying?

  • Check Actions tab for errors
  • Ensure GitHub Pages is enabled in Settings
  • Verify the workflow file is present

MCP client can’t connect?

  • Verify the URL is correct
  • Check that the site is deployed and accessible
  • Ensure the Cloudflare Worker route is deployed for /mcp
  • If your client runs in a browser context, confirm its Origin is allowlisted via ALLOWED_ORIGINS (Worker env var)

Adding More Content

Add New Encounters

Edit data/encounters.json and add to the appropriate environment/difficulty array.

Add New Names

Edit data/names.json and add to the race/gender arrays.

Add New Plot Hooks

Edit data/plot_hooks.json and add to the theme arrays.

Add New Tools

  1. Add a new tool module under cloudflare-mcp-server/src/tools/
  2. Register it in cloudflare-mcp-server/src/tools/registry.ts
  3. (Optional) Add a new JSON fixture under data/ if needed
  4. Update docs (README/Implementation/Project Structure) as needed

Happy Gaming! 🎲


Built with ❤️ for Game Masters everywhere! 🎲

This site uses Just the Docs, a documentation theme for Jekyll.