Brandwave/Docs

MCP Server#

The Brandwave MCP server lets AI agents interact with your creator marketing data using the Model Context Protocol. Connect it to Claude Desktop, Cursor, Windsurf, or any MCP-compatible client to query activities, manage campaigns, track performance, and more — all through natural language.

Server URL#

text
https://brandwave-dev-mcp.gobrandwave.com

Connecting your client#

Add the Brandwave MCP server to your client's configuration. The server uses OAuth 2.1 for authentication — your client will prompt you to sign in the first time you connect.

json
{
  "mcpServers": {
    "brandwave": {
      "url": "https://brandwave-dev-mcp.gobrandwave.com/mcp"
    }
  }
}

Authentication#

The MCP server uses OAuth 2.1 with PKCE. When you first connect, your client will open a browser window to sign in to Brandwave. After authenticating, the token is stored by your client and refreshed automatically.

Organization scope

If you belong to multiple organizations, the MCP server uses your active organization by default. Pass an organizationId when executing an action to target a specific organization.

Capability model#

The MCP server exposes a small set of always-loaded tools for context lookup and capability discovery. Resource-specific work happens through action slugs that you discover, inspect, and execute at runtime.

text
1. get-current-brandwave-context
2. discover-brandwave-capabilities
3. describe-brandwave-action
4. execute-brandwave-action
5. ping

Always-loaded tools#

These tools are always available as soon as your client connects. This list is generated from the MCP server's own tool definitions, so the docs stay aligned with the runtime surface.

get-current-brandwave-context#

Returns the authenticated user's profile (userId, email, name, jobRole, avatarUrl) and accessible organizations (activeOrganizationId, organizations, pending invitations). Use this first for any profile or identity question.

Read-onlyIdempotent

No parameters.

discover-brandwave-capabilities#

Use this first to list Brandwave resources and action slugs without loading parameter schemas. Optionally narrow by resource or free-text query. Returns JSON only; use describe-brandwave-action next for one action.

Read-onlyIdempotent

Parameters#

NameTypeRequiredDescription
resourcestring | null—Optional Brandwave resource slug to narrow discovery.
querystring | null—Optional free-text filter applied to resource and action metadata.

describe-brandwave-action#

Use this after discovery to fetch JSON schema, descriptions, annotations, SDK signature, HTTP endpoint, and ID-resolution behavior for one Brandwave action.

Read-onlyIdempotent

Parameters#

NameTypeRequiredDescription
resourcestringRequiredBrandwave resource slug returned by discover-brandwave-capabilities.
actionstringRequiredAction slug returned by discover-brandwave-capabilities.

execute-brandwave-action#

Use this to execute one validated Brandwave action after discovery and description. Returns JSON results or actionable validation/runtime errors.

Parameters#

NameTypeRequiredDescription
resourcestringRequiredBrandwave resource slug returned by discover-brandwave-capabilities.
actionstringRequiredAction slug returned by discover-brandwave-capabilities.
paramsobject | null—Params object to validate and pass to the Brandwave action.

ping#

Returns pong with the authenticated user email — verifies the MCP server is reachable.

Read-onlyIdempotent

No parameters.

Browse the resource pages for supported resources, action titles and slugs, example prompts, parameters, and execution hints.

Next steps#

MCP capabilities

Browse Brandwave resources and action slugs for the MCP capability layer.

TypeScript SDK

Use the SDK directly for programmatic access.