cityflavor-automations-mcp
v3.3.0
Published
MCP server for City Flavor portal operations - manage shifts, vendors, locations, events, schedulers (export/import), automations, and sales reporting through Claude Desktop
Maintainers
Readme
Claude Automations MCP Server
MCP (Model Context Protocol) server for managing Claude Automations in City Flavor. This allows you to create, update, view, and trigger automations directly from Claude Desktop.
Quick Start (Recommended)
Step 1: Generate an API Key
- Log into the City Flavor admin portal
- Go to Settings → API Keys
- Click "Generate New API Key"
- Select your event planner and ensure "Read-Write" access is enabled
- Copy the generated key (starts with something like
abc123...)
Step 2: Configure Claude Desktop
Add this to your Claude Desktop config - no manual installation needed!
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"ftf-automations": {
"command": "npx",
"args": ["-y", "cityflavor-automations-mcp"],
"env": {
"MCP_API_URL": "https://www.cityflavor.com",
"MCP_API_KEY": "your-api-key-here"
}
}
}
}Replace your-api-key-here with the API key you generated.
Step 3: Restart Claude Desktop
That's it! Restart Claude Desktop and you're ready to go.
Requirements
- Node.js 18+
- EventPlannerApiKey with read-write access (not read-only)
Installation Options
The MCP server supports two modes:
- Remote Mode (recommended): Connect directly to production via npm - no local setup needed
- Local Mode: For developers with the local Docker environment running
Remote Mode Setup (npm - Recommended)
This mode connects directly to production. No Docker or local FTF setup required.
Option A: Auto-install via npx (Easiest)
Just add this config to Claude Desktop - npx will automatically download and run the package:
{
"mcpServers": {
"ftf-automations": {
"command": "npx",
"args": ["-y", "cityflavor-automations-mcp"],
"env": {
"MCP_API_URL": "https://www.cityflavor.com",
"MCP_API_KEY": "your-api-key-here"
}
}
}
}Option B: Install globally
npm install -g cityflavor-automations-mcpThen configure Claude Desktop:
{
"mcpServers": {
"ftf-automations": {
"command": "cityflavor-automations-mcp",
"env": {
"MCP_API_URL": "https://www.cityflavor.com",
"MCP_API_KEY": "your-api-key-here"
}
}
}
}Environment Variables:
MCP_API_URL: Production URL (https://www.cityflavor.com) or sandbox (https://sandbox.cityflavor.com)MCP_API_KEY: Your EventPlannerApiKey (generate from admin portal, must have read-write access)
Restart Claude Desktop
After updating the configuration, restart Claude Desktop to load the MCP server.
Local Mode Setup (For Developers)
This mode uses Docker exec to run Django commands locally. Requires the FTF Docker environment.
1. Install Dependencies
cd /path/to/ftf/services/ftf/automation-mcp-server
npm install2. Configure Claude Desktop
{
"mcpServers": {
"ftf-automations": {
"command": "docker",
"args": [
"exec",
"-i",
"ftf",
"node",
"/ftf/automation-mcp-server/server.js"
],
"env": {
"MCP_MODE": "local",
"DJANGO_PATH": "/ftf",
"MCP_USER_EMAIL": "[email protected]"
}
}
}
}3. Ensure Docker is Running
Make sure FTF containers are running: docker compose ps
4. Restart Claude Desktop
Permissions
The MCP server authenticates using an EventPlannerApiKey. You must have:
- An API key with read-write access (not read-only)
- The API key must be associated with at least one event planner
God event planners (API keys associated with a god EventPlanner) can see and manage automations across all event planners. Regular API keys can only manage automations for their associated organization(s).
Available Tools
Once installed, you'll have access to these tools in Claude Desktop:
Automation Management
| Tool | Description |
|------|-------------|
| list_automations | List all Claude automations |
| get_automation | Get detailed info about an automation |
| create_automation | Create a new automation |
| update_automation | Update an existing automation |
| delete_automation | Delete (archive) an automation |
| trigger_automation | Run an automation immediately |
| toggle_automation | Pause/resume an automation |
Run History
| Tool | Description |
|------|-------------|
| list_automation_runs | List recent runs (optionally filter by automation) |
| get_automation_run | Get detailed run info including response |
Example Usage
In Claude Desktop, you can now say things like:
- "List all my automations"
- "Show me the details of automation #5"
- "Create an automation that checks ordering pages every morning at 7am and reports issues to Slack"
- "Trigger the vendor reminder automation"
- "Show me the last 5 runs for the daily report automation"
- "Pause the menu check automation"
Available Smart Tags
When creating automations, you can use these smart tags in your prompts:
Date & Time
{{today}}- Current date (YYYY-MM-DD){{tomorrow}}- Tomorrow's date{{current_time}}- Current time{{is_business_hours}}- true if 8am-6pm weekdays
Shifts
{{active_shifts}}- Currently running shifts{{upcoming_shifts}}- Shifts in next 24 hours{{unconfirmed_shifts}}- Pending confirmation
Loops
{{#for_each active_shifts as shift}}
- {{shift.vendor.name}} at {{shift.location.name}}
{{/for_each}}Conditionals
{{#if_exists active_shifts}}
Active shifts found!
{{/if_exists}}MCP Tools Available in Automations
Automations can use these MCP tools:
linear- Create/manage Linear issuesslack- Send Slack messagespuppeteer- Browser automation (check pages, screenshots)kyoo- Query ordering system
Troubleshooting
"Valid API key required"
Make sure you've set the MCP_API_KEY environment variable in your Claude Desktop config.
"API key has no associated event planners"
Your API key isn't linked to any event planners. Generate a new key or contact an admin.
"API key is read-only"
The MCP server requires read-write access. Generate a new API key with read-write permissions.
"Failed to connect to API"
- Check your internet connection
- Verify
MCP_API_URLis correct (https://www.cityflavor.comfor production) - Make sure the site is accessible
Testing the API
curl -H "Authorization: Api-Key YOUR_API_KEY" https://www.cityflavor.com/portal/api/mcp/automations/Security Notes
- API keys are secrets - treat them like passwords, never share or commit them
- API keys use the industry-standard
rest_framework_api_keyDjango package - Keys are hashed in the database (cannot be retrieved if lost)
- Regular API keys can only manage automations for their associated organization(s)
- God event planner API keys can view and manage all automations across all organizations
- API endpoints use HTTPS for secure communication
- Generate separate API keys for different purposes (revoke individually if compromised)
