Quick Start Guide
Table of contents
- Local Development
- Deploy to GitHub Pages
- Configure MCP Client
- Next Steps
- Troubleshooting
- Adding More Content
Local Development
- Install Dependencies
bundle install - Run Jekyll Locally
bundle exec jekyll serve - View Site Open http://localhost:4000/
Deploy to GitHub Pages
- Push to GitHub
git add . git commit -m "Initial commit: TTRPG GM Tools MCP Server" git push origin main - Enable GitHub Pages
- Go to repository Settings
- Navigate to Pages section
- Source: GitHub Actions (should be auto-detected)
- The
.github/workflows/jekyll.ymlwill handle deployment
- 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
- Customize Data: Edit JSON files in
data/to add your own content - Test Locally: Run
bundle install && bundle exec jekyll servefrom the repo root - Push Changes: Commit and push to automatically redeploy
- 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
- Add a new tool module under
cloudflare-mcp-server/src/tools/ - Register it in
cloudflare-mcp-server/src/tools/registry.ts - (Optional) Add a new JSON fixture under
data/if needed - Update docs (README/Implementation/Project Structure) as needed
Happy Gaming! 🎲