Foundryvtt MCP

🚀 FoundryVTT MCP Server

Integrate an MCP server with FoundryVTT, enabling AI assistants to interact with tabletop gaming sessions. Query actors, roll dice, generate content, and manage your game world using natural language.

🚀 Quick Start

The FoundryVTT MCP Server is a Model Context Protocol (MCP) server integrated with FoundryVTT. It allows AI assistants to interact with your tabletop gaming sessions. You can query actors, roll dice, generate content, and manage your game world through natural language.

✨ Features

Core Functionality

• 🎲 Dice Rolling: Roll dice using standard RPG notation.
• 🔍 Data Querying: Search for actors, items, scenes, and journal entries.
• 📊 Game State: Access the current scene, combat status, and world information.
• 🎭 Content Generation: Generate NPCs, loot, and random encounters.
• 📝 Rule Lookup: Query game rules and mechanical information.

Real-time Integration

• 🔄 Live Updates: Use a WebSocket connection for real-time game state.
• ⚔️ Combat Management: Track initiative and combat state.
• 👥 User Awareness: See who's online and their status.

AI-Powered Features

• 🧠 Tactical Suggestions: Get combat advice and strategy tips.
• 🎪 Story Assistance: Generate plot hooks and narrative elements.
• 🎨 World Building: Create locations, NPCs, and quests on demand.

📦 Installation

Prerequisites

• Node.js 18+
• A running and accessible FoundryVTT server
• An MCP-compatible AI client (e.g., Claude Desktop)

Quick Setup (Recommended)

🧙‍♂️ Interactive Setup Wizard:

git clone <repository-url>
cd foundry-mcp-server
npm install
npm run setup-wizard

The setup wizard will:

• Automatically detect your FoundryVTT server.
• Test connectivity and authentication.
• Generate your .env configuration file.
• Validate the complete setup.

Manual Setup

1. Clone and install:

git clone <repository-url>
cd foundry-mcp-server
npm install

2. Configure environment:

cp .env.example .env
# Edit .env with your FoundryVTT details

3. Required environment variables:

FOUNDRY_URL=http://localhost:30000
FOUNDRY_API_KEY=your_api_key_here
# OR use username/password:
FOUNDRY_USERNAME=your_username
FOUNDRY_PASSWORD=your_password

4. Test and start:

npm run test-connection  # Verify setup
npm run build
npm start

Development Mode

npm run dev

📚 Documentation

FoundryVTT Configuration

The MCP server supports two secure, local-only authentication methods:

Option 1: Local REST API Module (🔒 Recommended)

Benefits:

• ✅ 100% Local: No external dependencies or third-party services.
• ✅ Maximum Privacy: Your game data never leaves your network.
• ✅ Full Control: You own and manage all authentication.
• ✅ Better Performance: Direct local API access.
• ✅ Complete API Access: Full access to all FoundryVTT features.

Setup:

1. Install the Foundry Local REST API module:
   • In FoundryVTT: Setup → Add-on Modules → Install Module
   • Paste: https://github.com/laurigates/foundryvtt-mcp/releases/latest/download/module.json
2. Enable the module in your world.
3. Go to Settings → Configure Settings → Module Settings.
4. Find "Foundry Local REST API" and check "Enable REST API".
5. Copy the generated API Key.
6. Add to your .env file:

   FOUNDRY_URL=http://localhost:30000
   FOUNDRY_API_KEY=your_local_api_key_here
   

Option 2: Username/Password (Fallback)

Use when: The Local REST API module is not available or for simple setups.

Limitations: Some advanced features may not work properly.

1. Ensure your FoundryVTT user has appropriate permissions.
2. Add credentials to .env file:

   FOUNDRY_URL=http://localhost:30000
   FOUNDRY_USERNAME=your_username
   FOUNDRY_PASSWORD=your_password
   

Comparison Table

Required Permissions (All Methods)

Your FoundryVTT user needs these permissions:

• View actors, items, scenes, and journals.
• Create and modify journal entries (for content generation).
• Access compendium data.
• Use the dice rolling API.

💻 Usage Examples

Basic Queries

Ask your AI assistant things like:

Dice Rolling

• "Roll 1d20+5 for an attack roll"
• "Roll 4d6 drop lowest for ability scores"
• "Roll 2d10+3 for damage"

Game Data

• "Show me all the NPCs in this scene"
• "Find magic weapons in the party's inventory"
• "What's the current combat initiative order?"
• "Search for healing potions"

Content Generation

• "Generate a random NPC merchant"
• "Create loot for a CR 5 encounter"
• "Generate a tavern with NPCs and plot hooks"

Advanced Features

Rule Lookups

• "Look up the grappling rules"
• "How does the Fireball spell work?"
• "What are the conditions for being frightened?"

Tactical Advice

• "Suggest tactics for fighting a dragon"
• "What should our wizard do this turn?"
• "Analyze this combat encounter"

World Building

• "Create a mysterious forest location"
• "Generate a side quest involving missing merchants"
• "Design a magic item appropriate for level 8 characters"

💻 Available Tools

Data Access

• search_actors: Find characters, NPCs, monsters.
• search_items: Find equipment, spells, consumables.
• search_journals: Search notes and handouts.
• get_scene_info: Get current scene details.
• get_actor_details: Get detailed character information.

Game Mechanics

• roll_dice: Roll dice with any formula.
• update_actor_hp: Modify character health.
• get_combat_status: Get combat state and initiative.
• lookup_rule: Query game rules and spell descriptions.

Content Generation

• generate_npc: Create random NPCs.
• generate_loot: Create treasure appropriate for level.
• roll_table: Generate random encounters, events, weather.
• suggest_tactics: Get combat advice and strategy.

Diagnostics & System Health

• get_system_health: Get server performance and health metrics.
• get_recent_logs: Retrieve filtered FoundryVTT logs.
• search_logs: Search logs with regex patterns.
• diagnose_errors: Analyze errors with troubleshooting suggestions.

📚 Documentation

Server Settings

Edit .env to customize:

# Logging
LOG_LEVEL=info  # debug, info, warn, error

# Performance
FOUNDRY_TIMEOUT=10000      # Request timeout (ms)
FOUNDRY_RETRY_ATTEMPTS=3   # Retry failed requests
CACHE_TTL_SECONDS=300      # Cache data for 5 minutes

Security

• Use API keys instead of passwords when possible.
• Limit FoundryVTT user permissions to the minimum required.
• Run the server on an internal network only.
• Monitor logs for suspicious activity.

Diagnostics & Troubleshooting

Built-in Diagnostics

The server includes comprehensive diagnostic tools to help troubleshoot connection and performance issues:

Connection Testing:

# Test complete MCP connection and functionality
npm run test-connection

# Clean build and test setup
npm run setup

Diagnostic Tools (via AI assistant):

• System Health: "Get the FoundryVTT system health status"
• Error Analysis: "Diagnose recent errors and provide recommendations"
• Log Search: "Search logs for 'connection' patterns in the last hour"
• Recent Issues: "Show me recent error logs"

Advanced Diagnostics

When using the Local REST API module, you get access to advanced diagnostic features:

• 🔍 Real-time Log Analysis: Monitor FoundryVTT console output and notifications.
• 📊 System Health Metrics: Get server performance, memory usage, and client connections.
• 🎯 Error Pattern Recognition: Automatically detect common issues.
• 💡 Smart Suggestions: Get context-aware troubleshooting recommendations.
• 📈 Performance Monitoring: Track server uptime and response times.

Connection Issues

# Test FoundryVTT connection
curl http://localhost:30000/api/status

# Check server logs
npm run dev  # Shows detailed logging

Common Problems

"Failed to connect to FoundryVTT"

• Verify FOUNDRY_URL is correct.
• Check if FoundryVTT is running.
• Ensure API access is enabled.

"Authentication failed"

• Verify the API key or username/password.
• Check user permissions in FoundryVTT.
• Ensure the user is not banned/restricted.

"Tool not found" errors

• Update to the latest server version.
• Check tool name spelling.
• Review available tools in logs.

Development

Project Structure

src/
├── config/           # Configuration management
├── foundry/          # FoundryVTT client and types
├── tools/            # MCP tool definitions
├── resources/        # MCP resource definitions
├── utils/            # Utilities and logging
└── index.ts          # Main server entry point

Adding New Tools

1. Define the tool schema in src/tools/index.ts.
2. Add the handler method in src/index.ts.
3. Implement FoundryVTT API calls in src/foundry/client.ts.
4. Add TypeScript types in src/foundry/types.ts.
5. Test with your AI assistant.

Testing

# Run tests
npm test

# Run with coverage
npm run test:coverage

# Lint code
npm run lint

Building

# Development build
npm run build

# Clean build
npm run clean && npm run build

API Reference

Environment Variables

⭐ Either an API key OR username/password is required.

Tool Schemas

roll_dice

{
  "formula": "1d20+5",
  "reason": "Attack roll against goblin"
}

search_actors

{
  "query": "goblin",
  "type": "npc",
  "limit": 10
}

generate_npc

{
  "race": "human",
  "level": 5,
  "role": "merchant",
  "alignment": "neutral good"
}

Integration Examples

Claude Desktop Configuration

Add to your Claude Desktop MCP settings:

{
  "mcpServers": {
    "foundry": {
      "command": "node",
      "args": ["/path/to/foundry-mcp-server/dist/index.js"],
      "env": {
        "FOUNDRY_URL": "http://localhost:30000",
        "FOUNDRY_API_KEY": "your_api_key_here"
      }
    }
  }
}

Custom MCP Client

import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";

const transport = new StdioClientTransport({
  command: "node",
  args: ["./dist/index.js"],
});

const client = new Client(
  {
    name: "foundry-client",
    version: "1.0.0",
  },
  {
    capabilities: {},
  },
);

await client.connect(transport);

// Roll dice
const result = await client.request({
  method: "tools/call",
  params: {
    name: "roll_dice",
    arguments: {
      formula: "1d20+5",
      reason: "Initiative roll",
    },
  },
});

Roadmap

Version 0.2.0

• [ ] Combat management tools (start/end combat, advance initiative)
• [ ] Token manipulation (move, update status effects)
• [ ] Scene navigation and switching
• [ ] Playlist controls and ambient audio

Version 0.3.0

• [ ] Character sheet editing (level up, add equipment)
• [ ] Journal entry creation and editing
• [ ] Macro execution and management
• [ ] Advanced content generation (dungeons, NPCs with full stats)

Version 1.0.0

• [ ] Multi-world support
• [ ] User permission management
• [ ] Webhook support for external triggers
• [ ] Performance optimization and caching
• [ ] Full test coverage
• [ ] Docker deployment

Documentation

Complete API documentation is available in the docs/ directory, auto-generated from TypeScript source code and JSDoc comments.

📖 Viewing Documentation

Local development:

npm run docs        # Generate documentation
npm run docs:serve  # Generate and serve locally

Online: Browse the docs/ folder in this repository or visit the GitHub Pages site (if enabled).

📚 What's Documented

• FoundryClient API: Complete client documentation with examples.
• TypeScript Interfaces: All data structures and type definitions.
• Configuration: Environment variables and setup options.
• Utilities: Helper functions and logging.
• Usage Examples: Code samples for common operations.

The documentation is automatically updated via GitHub Actions when the source code changes.

🔧 Technical Details

Contributing

1. Fork the repository.
2. Create a feature branch: git checkout -b feature/amazing-feature.
3. Make your changes and add tests.
4. Commit: git commit -m 'Add amazing feature'.
5. Push: git push origin feature/amazing-feature.
6. Open a Pull Request.

Code Style

• Use TypeScript strict mode.
• Follow existing naming conventions.
• Add JSDoc comments for public APIs.
• Write tests for new functionality.
• Use meaningful commit messages.

📄 License

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

Troubleshooting

🔍 Quick Diagnostics

npm run test-connection      # Test FoundryVTT connectivity
npm run setup-wizard        # Re-run interactive setup

🏥 Health Check

Use the get_health_status MCP tool for comprehensive diagnostics, or check server logs during startup for detailed status information.

📚 Common Issues

• Connection refused: Ensure FoundryVTT is running on the configured port.
• Authentication failed: Verify the API key or username/password in .env.
• Empty search results: Install and enable the "Foundry Local REST API" module.
• Limited functionality: The REST API module is required for full features.

📖 Detailed troubleshooting guide: TROUBLESHOOTING.md

Support

• Issues: Report bugs and feature requests on GitHub Issues.
• Discord: Join the FoundryVTT Discord #api-development channel.
• Documentation: Refer to the FoundryVTT API Docs.
• Troubleshooting: Check the TROUBLESHOOTING.md file.

Acknowledgments

• The FoundryVTT team for the excellent VTT platform.
• Anthropic for the Model Context Protocol.
• The tabletop gaming community for inspiration and feedback.

Happy Gaming! 🎲