Skip to content

MCP Setup

The Pidgr MCP (Model Context Protocol) server enables AI agents to interact with your Pidgr organization through natural language. It translates MCP tool calls into gRPC RPCs against the Pidgr API.

  • Open source — Apache 2.0 license
  • Dual deployment — Run locally on your machine or connect to the hosted server at mcp.pidgr.com
  • Dual transport — stdio (for Claude Code, Cursor, Windsurf) and streamable HTTP (for hosted/remote agents)
  • 49 tools — Covering campaigns, templates, members, teams, groups, organizations, roles, API keys, heatmaps, and replays

The fastest way to get started. Connect directly to mcp.pidgr.com — no binary to download, no environment variables to configure.

Terminal window
claude mcp add --transport http pidgr https://mcp.pidgr.com

Or add manually to .claude/settings.json:

{
"mcpServers": {
"pidgr": {
"url": "https://mcp.pidgr.com"
}
}
}

Add to .cursor/mcp.json:

{
"mcpServers": {
"pidgr": {
"url": "https://mcp.pidgr.com"
}
}
}

Add to your Windsurf MCP configuration:

{
"mcpServers": {
"pidgr": {
"url": "https://mcp.pidgr.com"
}
}
}

The hosted server uses OAuth 2.0 for authentication. Your MCP client will prompt you to sign in with your Pidgr account when you first connect.

Run the MCP binary on your machine. Useful for air-gapped environments, custom API endpoints, or development against a local Pidgr API.

Download the latest binary for your platform from GitHub Releases:

Terminal window
# macOS (Apple Silicon)
curl -LO https://github.com/pidgr/pidgr-mcp/releases/latest/download/pidgr-mcp_darwin_arm64.tar.gz
tar xzf pidgr-mcp_darwin_arm64.tar.gz
chmod +x pidgr-mcp
# Verify checksum
sha256sum -c checksums.txt
# Add to PATH
sudo mv pidgr-mcp /usr/local/bin/
Terminal window
docker pull ghcr.io/pidgr/pidgr-mcp:latest
Terminal window
git clone https://github.com/pidgr/pidgr-mcp.git
cd pidgr-mcp
go build -o pidgr-mcp ./cmd/pidgr-mcp

The local server authenticates with a static API key. Create one in the admin dashboard under SettingsAPI Keys.

Terminal window
claude mcp add pidgr -e PIDGR_API_KEY=pidgr_k_your_key -- pidgr-mcp

Or add manually to .claude/settings.json:

{
"mcpServers": {
"pidgr": {
"command": "pidgr-mcp",
"env": {
"PIDGR_API_KEY": "pidgr_k_your_key"
}
}
}
}

Add to .cursor/mcp.json:

{
"mcpServers": {
"pidgr": {
"command": "pidgr-mcp",
"env": {
"PIDGR_API_KEY": "pidgr_k_your_key"
}
}
}
}
{
"mcpServers": {
"pidgr": {
"command": "pidgr-mcp",
"env": {
"PIDGR_API_KEY": "pidgr_k_your_key"
}
}
}
}
VariableRequiredDescription
PIDGR_API_KEYYesAPI key for authentication
PIDGR_API_URLNoAPI endpoint (default: https://api.pidgr.com)

Point the MCP server at a local Pidgr API:

Terminal window
PIDGR_API_KEY=pidgr_k_dev_key \
PIDGR_API_URL=http://localhost:50051 \
pidgr-mcp
Hosted (mcp.pidgr.com)Local binary
SetupOne command, no installDownload binary + API key
AuthOAuth sign-in via browserStatic API key
UpdatesAutomaticManual binary update
Custom API URLNoYes
Air-gappedNoYes
Best forMost usersCustom environments, local dev

The MCP server exposes 49 tools across 10 service domains:

DomainToolsExamples
Campaigns7Create, start, list, get, update, cancel, list deliveries
Templates4Create, update, get, list
Members6Invite, get, list, update role, deactivate, update profile
Teams8CRUD, member management
Groups9CRUD, member management, user memberships
Organizations4Create, get, update, list
Roles4List, create, update, delete
API Keys3Create, list, revoke
Heatmaps2Ingest events, query data
Replays2List recordings, get snapshots

Once configured, AI agents can interact with Pidgr naturally:

“Create a campaign called ‘Security Update Q1’ targeting the Engineering group with the security-update template”

“Show me the delivery status for the latest campaign”

“List all members with the Manager role”

“Create a new API key for the CI integration”

Verify PIDGR_API_URL is correct and the API is reachable:

Terminal window
curl -s https://api.pidgr.com/health
  • Hosted: Sign out and sign back in. Ensure your Pidgr account has the required permissions.
  • Local: Verify PIDGR_API_KEY is set and not expired. Check the key hasn’t been revoked in the admin dashboard.

Download the latest binary from GitHub Releases and replace the existing binary.