Developers

Read one workspace from your own tools. Create the key in Settings, then Integrations. The token is shown once. A paid plan is required. Use the API tab for HTTP, or the MCP tab for Claude and Cursor.

Get an API key

The read API needs a key. The MCP server takes the same key, or an OAuth sign-in from Claude and ChatGPT. A paid plan is required.

Sign in to your workspace.
Open Organization settings, then Integrations.
Under API keys and MCP, name a key and click Create key.
Copy the token from the notice. It starts with dbk_ and is shown once.
Send it as Authorization: Bearer dbk_… or as X-API-Key.

Create an API key

Revoke a key from the same list when you need to rotate it. A missing or revoked key returns 401. A free workspace returns 402.

GET /api/v1/competitors
Authorization: Bearer dbk_…

Request

GET /api/v1/competitors
Authorization: Bearer dbk_…

Response

{
  "data": [
    {
      "id": 42,
      "name": "Acme Analytics",
      "website_url": "https://acme.example",
      "category": "Analytics",
      "watch": "core",
      "tracked_since": "2026-01-12T09:00:00Z",
      "url": "https://debriefing.io/competitors/42"
    },
    {
      "id": 57,
      "name": "Northwind AI",
      "website_url": "https://northwind.example",
      "category": "AI",
      "watch": "horizon",
      "tracked_since": "2026-03-02T14:30:00Z",
      "url": "https://debriefing.io/competitors/57"
    }
  ]
}

Parameters

id path · required
Competitor id from the watchlist.

Request

GET /api/v1/competitors/42
Authorization: Bearer dbk_…

Response

{
  "data": {
    "id": 42,
    "name": "Acme Analytics",
    "description": "Product analytics for B2B SaaS teams.",
    "website_url": "https://acme.example",
    "category": "Analytics",
    "industry": "Software",
    "company_type": "private",
    "business_model": "subscription",
    "company_size": 120,
    "founding_year": 2018,
    "headquarters": {
      "city": "San Francisco",
      "country": "US"
    },
    "target_customer": "B2B SaaS product teams",
    "ownership": {
      "type": "private",
      "public": false
    },
    "urls": {
      "pricing": "https://acme.example/pricing",
      "docs": "https://docs.acme.example",
      "linkedin": "https://www.linkedin.com/company/acme"
    },
    "watch": "core",
    "priority": 1,
    "tracked_since": "2026-01-12T09:00:00Z",
    "workspace": {
      "relative_risk": "medium",
      "relative_opportunity": "high",
      "icp_overlap": {
        "score": "high",
        "notes": "Same ICP in mid-market SaaS."
      }
    },
    "reads": {
      "positioning": "Product analytics for growth and product teams.",
      "pricing": {
        "plans": [
          {
            "name": "Pro",
            "price": "$99/mo"
          }
        ],
        "recent_changes": []
      },
      "funding": {
        "total_raised_text": "$45M",
        "last_round": "Series B",
        "estimated_revenue_text": "$8M–$12M ARR"
      },
      "traffic": {
        "monthly_visits": 180000,
        "trend": "up"
      },
      "fortnight": {
        "written_at": "2026-09-20T08:00:00Z",
        "sentences": [
          {
            "text": "Acme raised pricing on the Pro plan.",
            "kind": "pricing"
          }
        ]
      }
    },
    "freshness": {
      "state_updated_at": "2026-09-22T11:00:00Z",
      "last_signal_at": "2026-09-21T16:40:00Z",
      "last_snapshot_at": "2026-09-22T10:55:00Z"
    },
    "links": {
      "signals": "/api/v1/signals?competitor_id=42",
      "battlecard_id": 9,
      "url": "https://debriefing.io/competitors/42"
    }
  }
}

Parameters

competitor_id query
Limit to one tracked competitor.
severity query
low, medium, or high.
since query
ISO 8601 time. First seen on or after this time.
q query
Case-insensitive match on title or summary.
page query
Page number. Default 1.
per_page query
Page size. Default 50. Maximum 50.

Request

GET /api/v1/signals?severity=high&per_page=2
Authorization: Bearer dbk_…

Response

{
  "data": [
    {
      "id": 881,
      "competitor_id": 42,
      "competitor_name": "Acme Analytics",
      "title": "Acme raised Pro plan pricing",
      "summary": "The Pro plan moved from $79 to $99 per month on the public pricing page.",
      "category": "pricing",
      "type": "price_change",
      "severity": "high",
      "status": "open",
      "first_seen_at": "2026-09-21T16:40:00Z",
      "last_seen_at": "2026-09-21T16:40:00Z",
      "confidence": 0.92,
      "topics": [
        "pricing",
        "packaging"
      ],
      "evidence": [
        {
          "text": "Pro · $99 / month",
          "source_title": "Acme Pricing",
          "source_url": "https://acme.example/pricing",
          "observed_at": "2026-09-21T16:40:00Z"
        }
      ],
      "url": "https://debriefing.io/dashboard/signals/881"
    }
  ],
  "page": 1,
  "per_page": 2
}

Parameters

id path · required
Signal id.

Request

GET /api/v1/signals/881
Authorization: Bearer dbk_…

Response

{
  "data": {
    "id": 881,
    "competitor_id": 42,
    "competitor_name": "Acme Analytics",
    "title": "Acme raised Pro plan pricing",
    "summary": "The Pro plan moved from $79 to $99 per month on the public pricing page.",
    "category": "pricing",
    "type": "price_change",
    "severity": "high",
    "status": "open",
    "first_seen_at": "2026-09-21T16:40:00Z",
    "last_seen_at": "2026-09-21T16:40:00Z",
    "confidence": 0.92,
    "topics": [
      "pricing",
      "packaging"
    ],
    "evidence": [
      {
        "text": "Pro · $99 / month",
        "source_title": "Acme Pricing",
        "source_url": "https://acme.example/pricing",
        "observed_at": "2026-09-21T16:40:00Z"
      }
    ],
    "url": "https://debriefing.io/dashboard/signals/881"
  }
}

Parameters

type query
Debrief type, for example daily_digest or weekly_tldr.
page query
Page number. Default 1.
per_page query
Page size. Default 50. Maximum 50.

Request

GET /api/v1/digests?type=daily_digest
Authorization: Bearer dbk_…

Response

{
  "data": [
    {
      "id": 310,
      "slug": "daily-2026-09-22",
      "type": "daily_digest",
      "status": "generated",
      "title": "Daily digest · 22 Sep 2026",
      "headline": "Acme raised Pro pricing. Northwind opened a EU careers page.",
      "tldr": "Two moves matter today: Acme pricing and Northwind hiring in Europe.",
      "what_to_watch": "Watch whether Acme changes packaging next.",
      "coverage_period_start": "2026-09-21T00:00:00Z",
      "coverage_period_end": "2026-09-22T00:00:00Z",
      "generated_at": "2026-09-22T07:15:00Z",
      "signal_ids": [
        881,
        902
      ],
      "url": "https://debriefing.io/dashboard/digests/daily-2026-09-22"
    }
  ],
  "page": 1,
  "per_page": 50
}

Parameters

id path · required
Digest slug or numeric id.

Request

GET /api/v1/digests/daily-2026-09-22
Authorization: Bearer dbk_…

Response

{
  "data": {
    "id": 310,
    "slug": "daily-2026-09-22",
    "type": "daily_digest",
    "status": "generated",
    "title": "Daily digest · 22 Sep 2026",
    "headline": "Acme raised Pro pricing. Northwind opened a EU careers page.",
    "tldr": "Two moves matter today: Acme pricing and Northwind hiring in Europe.",
    "what_to_watch": "Watch whether Acme changes packaging next.",
    "coverage_period_start": "2026-09-21T00:00:00Z",
    "coverage_period_end": "2026-09-22T00:00:00Z",
    "generated_at": "2026-09-22T07:15:00Z",
    "signal_ids": [
      881,
      902
    ],
    "url": "https://debriefing.io/dashboard/digests/daily-2026-09-22"
  }
}

Request

GET /api/v1/battlecards
Authorization: Bearer dbk_…

Response

{
  "data": [
    {
      "id": 9,
      "competitor_id": 42,
      "competitor_name": "Acme Analytics",
      "status": "generated",
      "generated_at": "2026-09-20T12:00:00Z",
      "sections": {
        "overview": "Acme sells product analytics to mid-market SaaS.",
        "strengths": [
          "Strong product analytics brand",
          "Clear Pro packaging"
        ],
        "weaknesses": [
          "Price rose without a feature add"
        ],
        "talk_tracks": [
          "Ask what they get for the new Pro price."
        ]
      },
      "url": "https://debriefing.io/dashboard/battlecards/9"
    }
  ]
}

Parameters

id path · required
Battlecard id or competitor id.

Request

GET /api/v1/battlecards/9
Authorization: Bearer dbk_…

Response

{
  "data": {
    "id": 9,
    "competitor_id": 42,
    "competitor_name": "Acme Analytics",
    "status": "generated",
    "generated_at": "2026-09-20T12:00:00Z",
    "sections": {
      "overview": "Acme sells product analytics to mid-market SaaS.",
      "strengths": [
        "Strong product analytics brand",
        "Clear Pro packaging"
      ],
      "weaknesses": [
        "Price rose without a feature add"
      ],
      "talk_tracks": [
        "Ask what they get for the new Pro price."
      ]
    },
    "url": "https://debriefing.io/dashboard/battlecards/9"
  }
}

Codes

invalid_request 400 · Invalid request
Correct the parameter that the detail names. Then send the request again.
invalid_api_key 401 · API key missing or not valid
Send a valid key as Authorization: Bearer dbk_… or as X-API-Key. A workspace admin creates keys in Organization settings, under Integrations.
paid_plan_required 402 · Paid plan required
Choose a paid plan for this workspace on /pricing. The free week does not include the API.
forbidden 403 · Forbidden
Use a key from the workspace that owns this record. The read API does not send this code now.
not_found 404 · Not found
Check the path and the id. The list routes, such as /api/v1/competitors, give the ids that this key can read.
unprocessable_content 422 · Unprocessable content
Correct the value that the detail names. Then send the request again. The read API does not send this code now.
rate_limited 429 · Too many requests
Wait for the number of seconds in the Retry-After header. Then send the request again.
internal_error 500 · Internal error
Send the request again later. If the error continues, email team@debriefing.io with the request_id.

Request

GET /api/v1/competitors/999
Authorization: Bearer dbk_…

Response

{
  "type": "https://debriefing.io/developers#errors-not_found",
  "title": "Not found",
  "status": 404,
  "detail": "No such competitor.",
  "code": "not_found",
  "hint": "Check the path and the id. The list routes, such as /api/v1/competitors, give the ids that this key can read.",
  "instance": "/api/v1/competitors/999",
  "request_id": "5f1c2b7e-9a41-4c1e-8d0e-2b1f3a6c7d80",
  "error": "No such competitor."
}

Endpoint:

https://debriefing.io/mcp

Pick your client below.
Claude, ChatGPT, and Claude Code: add the URL, sign in to Debriefing, and select Approve. Other clients: create an API key and paste the config.
Ask the client to list your competitors.

Any member of a set-up workspace can approve a connection, on any plan. The consent screen lists three scopes: read (always), write (changes that cost nothing), and spend (actions that use a plan allowance). The app can do only what your role can do, and only what your plan allows. A tool that needs a paid plan says so and gives the pricing link. An admin sees each connected app in Organization settings, under Integrations, and can disconnect it there.

An API key only reads. To let an AI app make changes or use research budget, connect it with OAuth and tick Write or Spend.

Four tools need no sign-in: search_public_briefs, get_public_brief, search_guides, and get_free_brief_link. They read only what Debriefing publishes on debriefing.io, the public briefs and the CI guides, and never a workspace. A client that has not signed in can call them. Every other tool asks the person to sign in first.

Add to Claude

Claude on the web, on the desktop, and on mobile connects with OAuth. You sign in to Debriefing and approve the connection. You do not need an API key.

In Claude, open Customize, then Connectors. Select Add custom connector.
Enter the name Debriefing and the URL https://debriefing.io/mcp. Select Add.
Select Connect. Sign in to Debriefing and select Approve.
In a chat, open the + menu, then Connectors, and turn on Debriefing. Ask: Which competitors do we track?
On a Team or Enterprise plan, an owner adds the connector in Organization settings, then Connectors. Each member then selects Connect.

Add to ChatGPT

ChatGPT connects with OAuth. You sign in to Debriefing and approve the connection. To add an app by URL, ChatGPT needs developer mode. Plus, Pro, Business, Enterprise, and Edu plans have it on the web.

In ChatGPT on the web, open Settings and turn on Developer mode.
Create an app. Name: Debriefing. MCP server URL: https://debriefing.io/mcp. Authentication: OAuth.
Select Create. Sign in to Debriefing and select Approve.
In a chat, open the + menu and choose Debriefing. Ask: What did our competitors change this week?

Claude Code

Claude Code connects with OAuth, like Claude. It can also send an API key as a header.

Run: claude mcp add --transport http debriefing https://debriefing.io/mcp
Inside Claude Code, run /mcp, select debriefing, and select Authenticate. Sign in to Debriefing in the browser and select Approve.
To use an API key instead, add --header "Authorization: Bearer dbk_…" to the first command.

Cursor

Add a remote server in ~/.cursor/mcp.json or in the project .cursor/mcp.json. Put the key in an environment variable so it stays out of the file. To sign in with OAuth instead, leave out headers.

Create an API key in Settings, then Integrations. Copy it once.
Export DEBRIEFING_API_KEY=dbk_… in your shell profile.
Paste the config below. Restart Cursor.
Open Customize, confirm the debriefing server is on, then ask for your tracked competitors.

On Windows, keep the Bearer value in an env var. Do not put spaces inside the args string for Authorization.

~/.cursor/mcp.json

{
  "mcpServers": {
    "debriefing": {
      "url": "https://debriefing.io/mcp",
      "headers": {
        "Authorization": "Bearer ${env:DEBRIEFING_API_KEY}"
      }
    }
  }
}

Other MCP clients

Any client that can reach a Streamable HTTP MCP server can use the same endpoint. Clients that only speak stdio should use mcp-remote.

Endpoint: https://debriefing.io/mcp
Auth: OAuth 2.1 with PKCE, dynamic client registration, and client ID metadata documents. Scopes: read, write, and spend. Discovery starts at the 401 from a tools/call. Or send Authorization: Bearer dbk_… or X-API-Key: dbk_…
Transport: Streamable HTTP. Each POST gets one JSON answer. This server does not push over SSE.

stdio via mcp-remote

{
  "mcpServers": {
    "debriefing": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://debriefing.io/mcp",
        "--header",
        "Authorization:${AUTH_HEADER}"
      ],
      "env": {
        "AUTH_HEADER": "Bearer dbk_…"
      }
    }
  }
}

Get an API key

The read API needs a key. The MCP server takes the same key, or an OAuth sign-in from Claude and ChatGPT. A paid plan is required.

Sign in to your workspace.
Open Organization settings, then Integrations.
Under API keys and MCP, name a key and click Create key.
Copy the token from the notice. It starts with dbk_ and is shown once.
Send it as Authorization: Bearer dbk_… or as X-API-Key.

Create an API key

Revoke a key from the same list when you need to rotate it. A missing or revoked key returns 401. A free workspace returns 402.

Tools

Tools marked no sign-in read public debriefing.io content and need no credential. Every other tool works on one workspace: the one that owns the API key, or the one the person approved. Each tool names its scope. Tools marked admin need the admin role, as in the app. Tools that spend an allowance or send something take an idempotency_key: a retry with the same key returns the first answer. A refusal (scope, role, plan, allowance, or daily cap) and a missing row return isError: true with the reason and the link that fixes it. Open a tool for arguments and samples.

get_workspace read Gets the Debriefing workspace this connection works on: its name and website, who you are in it and your role, the scopes this connection holds, and the plan. Call it first when you are not sure what you may do.

No arguments.

Example result

{
  "id": 7,
  "name": "YourCo",
  "website_url": "https://yourco.example",
  "you": {
    "name": "Sam Lee",
    "email": "sam@yourco.example",
    "role": "admin"
  },
  "connection": {
    "credential": "oauth",
    "scopes": [
      "read",
      "write",
      "spend"
    ]
  },
  "plan": {
    "name": "growth",
    "paid": true,
    "free_week": false
  }
}

get_plan_and_limits read Gets the workspace plan and every limit an agent runs into: competitor slots, the weekly research allowance, the daily caps on battlecards, ICP refreshes and positioning drafts, share link lifetimes, monitoring cadences, and which features need a paid plan. Includes the pricing link.

No arguments.

Example result

{
  "plan": {
    "name": "growth",
    "paid": true
  },
  "competitor_slots": {
    "limit": 5,
    "used": 4,
    "remaining": 1
  },
  "research_allowance": {
    "limit": 4,
    "used": 1,
    "remaining": 3,
    "window_days": 7
  },
  "daily_caps": {
    "generate_battlecard": {
      "limit": 5,
      "used": 0,
      "remaining": 5
    }
  },
  "pricing_url": "https://debriefing.io/pricing"
}

list_competitors read Lists the competitors this Debriefing workspace tracks, with the id, name, website, and category of each. Call it first to get the competitor_id that other tools take.

No arguments.

Example result

{
  "items": [
    {
      "id": 42,
      "name": "Acme Analytics",
      "website_url": "https://acme.example",
      "category": "Analytics",
      "watch": "core"
    }
  ]
}

get_competitor read Gets the dossier for one tracked competitor: company facts, the risk and opportunity it poses to this workspace, and the stored reads on positioning, product, pricing, funding, traffic, and more. Use it when the user asks about one competitor in depth.

Arguments

competitor_id integer · required
An id from list_competitors

Example call

{
  "competitor_id": 42
}

Example result

{
  "id": 42,
  "name": "Acme Analytics",
  "reads": {
    "positioning": "Product analytics for growth and product teams.",
    "funding": {
      "last_round": "Series B",
      "estimated_revenue_text": "$8M–$12M ARR"
    }
  },
  "workspace": {
    "relative_risk": "medium",
    "relative_opportunity": "high"
  }
}

search_signals read paid plan or free week Searches open signals, newest first. A signal is a competitor move that Debriefing found, such as a price change or a launch, with the source evidence. Filter by competitor_id, severity (low, medium, high), a text query, or a since time. Use it when the user asks what a competitor changed.

Arguments

competitor_id integer
An id from list_competitors
severity string
low, medium, high
query string
Words to find in the signal title or summary
since string
ISO 8601 time. Only signals after this time.
limit integer

Example call

{
  "competitor_id": 42,
  "severity": "high",
  "limit": 5
}

Example result

{
  "items": [
    {
      "id": 881,
      "title": "Acme raised Pro plan pricing",
      "severity": "high",
      "evidence": [
        {
          "text": "Pro · $99 / month",
          "source_url": "https://acme.example/pricing"
        }
      ]
    }
  ]
}

list_digests read paid plan or free week Lists the digests Debriefing wrote for this workspace, newest first. A digest is a brief that sums up competitor moves over a period. Filter by type, such as daily_digest.

Arguments

type string
A digest type, such as daily_digest or weekly_tldr
limit integer

Example call

{
  "type": "daily_digest",
  "limit": 5
}

Example result

{
  "items": [
    {
      "id": 310,
      "slug": "daily-2026-09-22",
      "type": "daily_digest",
      "tldr": "Two moves matter today: Acme pricing and Northwind hiring in Europe."
    }
  ]
}

get_digest read paid plan or free week Gets one digest by id or slug, or the newest digest when no id is given. Pass type daily_digest for the newest daily digest. Use it when the user asks for the latest brief.

Arguments

id string
A digest id or slug from list_digests
type string
A digest type, such as daily_digest

Example call

{
  "id": "daily-2026-09-22"
}

Example result

{
  "id": 310,
  "slug": "daily-2026-09-22",
  "tldr": "Two moves matter today: Acme pricing and Northwind hiring in Europe.",
  "signal_ids": [
    881,
    902
  ]
}

list_battlecards read paid plan or free week Lists the battlecards Debriefing wrote for this workspace, one for each competitor that has one. A battlecard holds talk tracks for sales calls against that competitor.

No arguments.

Example result

{
  "items": [
    {
      "id": 9,
      "competitor_id": 42,
      "competitor_name": "Acme Analytics",
      "status": "generated"
    }
  ]
}

get_battlecard read paid plan or free week Gets one battlecard by competitor_id or battlecard_id. Use it when the user prepares a sales call against a competitor.

Arguments

competitor_id integer
An id from list_competitors
battlecard_id integer
An id from list_battlecards

Example call

{
  "competitor_id": 42
}

Example result

{
  "id": 9,
  "competitor_id": 42,
  "sections": {
    "overview": "Acme sells product analytics to mid-market SaaS.",
    "talk_tracks": [
      "Ask what they get for the new Pro price."
    ]
  }
}

get_evidence read paid plan or free week Gets the evidence behind one signal: each source excerpt with its URL and date. Use it when the user asks where a claim comes from.

Arguments

signal_id integer · required
An id from search_signals

Example call

{
  "signal_id": 881
}

Example result

{
  "signal_id": 881,
  "title": "Acme raised Pro plan pricing",
  "evidence": [
    {
      "text": "Pro · $99 / month",
      "source_title": "Acme Pricing",
      "source_url": "https://acme.example/pricing"
    }
  ]
}

add_competitor write admin Adds a competitor to the workspace's core watchlist from its website. Debriefing then monitors it. Admin only. The plan sets how many core competitors fit; get_plan_and_limits shows the free slots.

Arguments

website_url string · required
The competitor's website, such as https://acme.example

Example call

{
  "website_url": "https://northwind.example"
}

Example result

{
  "ok": true,
  "message": "Northwind is on the watchlist. Debriefing starts monitoring it now.",
  "competitor": {
    "id": 43,
    "name": "Northwind"
  }
}

rename_competitor write admin Changes the display name of one tracked competitor. Admin only.

Arguments

competitor_id integer · required
An id from list_competitors
name string · required

Example call

{
  "competitor_id": 42,
  "name": "Acme"
}

Example result

{
  "ok": true,
  "message": "The competitor is now called Acme.",
  "competitor": {
    "id": 42,
    "name": "Acme"
  }
}

remove_competitor write admin Takes one core competitor off the watchlist. Debriefing stops monitoring it and keeps its history. Admin only, on a paid plan.

Arguments

competitor_id integer · required
An id from list_competitors

Example call

{
  "competitor_id": 42
}

Example result

{
  "ok": true,
  "message": "Acme is off the watchlist. Its history stays.",
  "competitor": {
    "id": 42,
    "name": "Acme"
  }
}

add_monitored_page write admin paid plan Asks Debriefing to watch one more page of a core competitor, such as its pricing page. Changes on it then show up as signals. Up to 10 pages per competitor. Admin only, on a paid plan.

Arguments

competitor_id integer · required
An id from list_competitors
url string · required
The full page address

Example call

{
  "competitor_id": 42,
  "url": "https://acme.example/pricing"
}

Example result

{
  "ok": true,
  "message": "Debriefing now monitors https://acme.example/pricing.",
  "page": {
    "id": 77,
    "url": "https://acme.example/pricing"
  }
}

remove_monitored_page write admin paid plan Stops watching a page that someone added on a core competitor. Name it by page_id or url. Admin only, on a paid plan.

Arguments

competitor_id integer · required
An id from list_competitors
page_id integer
An id from add_monitored_page
url string

Example call

{
  "competitor_id": 42,
  "page_id": 77
}

Example result

{
  "ok": true,
  "message": "Debriefing no longer monitors https://acme.example/pricing.",
  "monitored_pages": []
}

research_competitor spend admin Starts the first research on one core competitor that has none yet: Debriefing reads its site and outside sources. It uses one update from the weekly research allowance. Admin only.

Arguments

competitor_id integer · required
An id from list_competitors
idempotency_key string · required
A unique string you make for this request, such as a UUID. Send the same key when you retry, and Debriefing returns the first answer instead of acting twice.

Example call

{
  "competitor_id": 43,
  "idempotency_key": "7f3c2a9e-research-43"
}

Example result

{
  "ok": true,
  "message": "Research on Northwind started. It takes a few minutes.",
  "refresh": {
    "id": 12,
    "status": "pending"
  },
  "replayed": false
}

refresh_watchlist spend admin Refreshes the research on the core watchlist now, instead of at the next cycle. It uses one update from the weekly research allowance. Admin only.

Arguments

idempotency_key string · required
A unique string you make for this request, such as a UUID. Send the same key when you retry, and Debriefing returns the first answer instead of acting twice.

Example call

{
  "idempotency_key": "b81d40c2-refresh"
}

Example result

{
  "ok": true,
  "message": "The watchlist refresh started. It takes a few minutes.",
  "refresh": {
    "id": 13,
    "status": "pending"
  },
  "replayed": false
}

pin_signal write Pins a signal for the whole team, or removes the pin with pinned false.

Arguments

signal_id integer · required
An id from search_signals or what_changed
pinned boolean

Example call

{
  "signal_id": 881,
  "pinned": true
}

Example result

{
  "ok": true,
  "message": "Pinned for the team.",
  "signal_id": 881,
  "pinned": true
}

save_signal write Saves a signal to your own saved list, or removes it with saved false. Only you see your saved signals.

Arguments

signal_id integer · required
An id from search_signals or what_changed
saved boolean

Example call

{
  "signal_id": 881,
  "saved": true
}

Example result

{
  "ok": true,
  "message": "Saved to your list.",
  "signal_id": 881,
  "saved": true
}

add_signal_note write Adds a talking point to a signal. The team sees it in the workspace. It never appears on a public link unless the link includes notes.

Arguments

signal_id integer · required
An id from search_signals or what_changed
body string · required
The talking point, in plain text

Example call

{
  "signal_id": 881,
  "body": "Lead with our flat price when Acme comes up."
}

Example result

{
  "ok": true,
  "message": "Talking point added.",
  "note": {
    "id": 5,
    "signal_id": 881
  }
}

rate_signal write Tells Debriefing whether a signal was useful to you. For not useful, add reasons and a comment. A new rating replaces your old one.

Arguments

signal_id integer · required
An id from search_signals or what_changed
useful boolean · required
reasons array
Only when useful is false
comment string

Example call

{
  "signal_id": 881,
  "useful": true
}

Example result

{
  "ok": true,
  "message": "Thanks. The rating is saved.",
  "rating": {
    "signal_id": 881,
    "useful": true
  }
}

pin_digest write Pins a digest for the whole team, or removes the pin with pinned false.

Arguments

digest_id string · required
A digest id or slug from list_digests
pinned boolean

Example call

{
  "digest_id": "daily-2026-09-22",
  "pinned": true
}

Example result

{
  "ok": true,
  "message": "Pinned for the team.",
  "digest_id": 310,
  "pinned": true
}

add_digest_note write Adds a talking point to a digest. The team sees it in the workspace.

Arguments

digest_id string · required
A digest id or slug from list_digests
body string · required
The talking point, in plain text

Example call

{
  "digest_id": "daily-2026-09-22",
  "body": "Share the pricing move with sales."
}

Example result

{
  "ok": true,
  "message": "Talking point added.",
  "note": {
    "id": 6,
    "digest_id": 310
  }
}

rate_digest write Scores a digest from 1 to 5, says what is missing from it, or both. A new rating replaces your old one.

Arguments

digest_id string · required
A digest id or slug from list_digests
score integer
comment string
What is missing from the digest

Example call

{
  "digest_id": "daily-2026-09-22",
  "score": 5
}

Example result

{
  "ok": true,
  "message": "Thanks. The rating is saved.",
  "rating": {
    "digest_id": 310,
    "score": 5
  }
}

generate_battlecard spend paid plan or free week daily cap Writes or rewrites the battlecard for one core competitor now, instead of at the next cycle. It takes about a minute; read it afterwards with get_battlecard. The competitor needs finished research. Needs a paid plan or the free first week, and counts toward a daily cap per workspace.

Arguments

competitor_id integer · required
An id from list_competitors
idempotency_key string · required
A unique string you make for this request, such as a UUID. Send the same key when you retry, and Debriefing returns the first answer instead of acting twice.

Example call

{
  "competitor_id": 42,
  "idempotency_key": "c19a2f7e-card-42"
}

Example result

{
  "ok": true,
  "message": "Writing the battlecard for Acme Analytics. It takes about a minute. Read it with get_battlecard.",
  "daily_cap": {
    "limit": 5,
    "used": 1,
    "remaining": 4
  },
  "replayed": false
}

add_battlecard_note write Adds what the team knows about a core competitor that no page says. The next rewrite of its battlecard reads the note as framing, never as a verified fact.

Arguments

competitor_id integer · required
An id from list_competitors
body string · required
The talking point, in plain text

Example call

{
  "competitor_id": 42,
  "body": "Their onboarding takes two weeks; ours takes a day."
}

Example result

{
  "ok": true,
  "message": "Note added. The next rewrite of this battlecard reads it.",
  "note": {
    "id": 3,
    "competitor_id": 42
  }
}

get_company_profile read Gets the workspace's own company profile: description, category, target customer, positioning lists, and the ideal customer profile. Debriefing reads every competitor move against it.

No arguments.

Example result

{
  "profile": {
    "name": "YourCo",
    "target_customer": "Product teams at B2B SaaS companies"
  },
  "positioning": {
    "differentiators": [
      "Evidence on every signal"
    ]
  },
  "ideal_customer_profile": {
    "industries": [
      "B2B SaaS"
    ]
  },
  "locked": false
}

update_company_profile write admin Changes fields of the workspace's company profile. Only the fields you send change. The lists replace the old lists. Admin only. Locked while the first brief runs.

Arguments

name string
website_url string
description string
industry string
primary_category string
target_customer string
self_positioning string
company_size integer
company_type string
software_vendor, service_provider, marketplace, ecommerce_brand, media_publisher, nonprofit, government, fintech_institution, healthcare_provider, manufacturer, education_provider, other
hq_country string
operating_regions array
Regions where the company sells
market_position string
market_direction string
value_propositions array
Up to 12 short items
differentiators array
Up to 12 short items
positioning_exclusions array
What the company does not do. Up to 12 short items

Example call

{
  "target_customer": "Product teams at B2B SaaS companies",
  "differentiators": [
    "Evidence on every signal"
  ]
}

Example result

{
  "ok": true,
  "message": "The company profile is saved."
}

update_icp spend admin daily cap Sets the ideal customer profile, then re-reads how much each tracked competitor overlaps it. Only the dimensions you send change; an empty list clears one. Admin only. Counts toward a daily cap per workspace. Locked while the first brief runs.

Arguments

customer_types array
Customer types
company_sizes array
Company sizes
company_stages array
Company stages
industries array
Industries
geographies array
Geographies
buyer_roles array
Buyer roles
user_roles array
User roles
use_cases array
Use cases
idempotency_key string · required
A unique string you make for this request, such as a UUID. Send the same key when you retry, and Debriefing returns the first answer instead of acting twice.

Example call

{
  "industries": [
    "B2B SaaS"
  ],
  "buyer_roles": [
    "Head of Product"
  ],
  "idempotency_key": "4d2e8b10-icp"
}

Example result

{
  "ok": true,
  "message": "The ideal customer profile is saved.",
  "daily_cap": {
    "limit": 5,
    "used": 1,
    "remaining": 4
  },
  "replayed": false
}

draft_positioning spend admin daily cap Reads the company's own website and drafts the empty positioning fields: value propositions, differentiators, and exclusions. Filled fields stay as they are. Read the result later with get_company_profile. Admin only. Counts toward a daily cap per workspace.

Arguments

idempotency_key string · required
A unique string you make for this request, such as a UUID. Send the same key when you retry, and Debriefing returns the first answer instead of acting twice.

Example call

{
  "idempotency_key": "9a7c5e33-positioning"
}

Example result

{
  "ok": true,
  "message": "Debriefing is reading the company website.",
  "daily_cap": {
    "limit": 5,
    "used": 1,
    "remaining": 4
  },
  "replayed": false
}

get_delivery_settings read admin Gets how often Debriefing runs a monitoring cycle for the workspace, the cadences the plan allows, and whether a finished cycle goes out by email and to Slack. Admin only.

No arguments.

Example result

{
  "monitoring_cadence": {
    "current": "weekly",
    "allowed": [
      "weekly",
      "biweekly"
    ]
  },
  "delivery_channels": {
    "email": true,
    "slack": false,
    "slack_connected": false
  }
}

set_monitoring_cadence write admin Sets how often Debriefing runs a monitoring cycle. The plan decides which cadences are allowed; get_delivery_settings lists them. Admin only, on a paid plan.

Arguments

cadence string · required
A cadence from get_delivery_settings, such as weekly

Example call

{
  "cadence": "weekly"
}

Example result

{
  "ok": true,
  "message": "Debriefing now runs a weekly monitoring cycle."
}

set_delivery_channels write admin Turns delivery of a finished cycle by email and to Slack on or off. Only the channels you send change. Slack needs a paid plan and a Slack connection made in the app. Admin only.

Arguments

email boolean
slack boolean

Example call

{
  "email": true,
  "slack": false
}

Example result

{
  "ok": true,
  "message": "Delivery channels saved.",
  "delivery_channels": {
    "email": true,
    "slack": false
  }
}

create_share_link write Makes a public link to one signal that anyone with the address can open. A new link replaces the old one, which stops working. The plan sets how long a link can live; the free plan and Starter allow 24 hours.

Arguments

signal_id integer · required
An id from search_signals or what_changed
expiry string
How long the link works. The free plan and Starter allow only 24h, and any other choice becomes 24h there.
include_notes boolean
Show the team's talking points on the public page
idempotency_key string · required
A unique string you make for this request, such as a UUID. Send the same key when you retry, and Debriefing returns the first answer instead of acting twice.

Example call

{
  "signal_id": 881,
  "expiry": "7d",
  "idempotency_key": "e2b6c8d4-share-881"
}

Example result

{
  "ok": true,
  "message": "Public link ready. Anyone with the address can open it.",
  "share": {
    "signal_id": 881,
    "url": "https://debriefing.io/shared/signals/Xc8…",
    "expiry": "7d"
  },
  "replayed": false
}

list_members read Lists the people in the workspace with their roles. An admin also sees pending invitations.

No arguments.

Example result

{
  "items": [
    {
      "id": 1,
      "name": "Sam Lee",
      "email": "sam@yourco.example",
      "role": "admin"
    }
  ]
}

invite_member write admin Sends an email invitation to join the workspace as a member. The invitation lasts 7 days. Inviting the same address again sends a fresh email. Admin only, on a paid plan.

Arguments

email string · required
idempotency_key string · required
A unique string you make for this request, such as a UUID. Send the same key when you retry, and Debriefing returns the first answer instead of acting twice.

Example call

{
  "email": "sam@yourco.example",
  "idempotency_key": "0c4f1a9b-invite-sam"
}

Example result

{
  "ok": true,
  "message": "Invitation sent to ana@yourco.example. It lasts 7 days.",
  "invitation": {
    "email": "ana@yourco.example",
    "status": "pending"
  },
  "replayed": false
}

what_changed read paid plan or free week Lists everything new in the workspace since a time: signals Debriefing found, digests it wrote, and battlecards it wrote or rewrote. Use it to catch up, such as since the user's last visit.

Arguments

since string · required
ISO 8601 time, such as 2026-10-01T00:00:00Z
limit integer
The most rows of each kind

Example call

{
  "since": "2026-09-28T00:00:00Z",
  "limit": 10
}

Example result

{
  "since": "2026-09-28T00:00:00Z",
  "signals": [
    {
      "id": 881,
      "title": "Acme raised Pro plan pricing",
      "severity": "high"
    }
  ],
  "digests": [
    {
      "id": 310,
      "type": "daily_digest"
    }
  ],
  "battlecards": []
}

search_public_briefs no sign-in Searches the competitive briefs Debriefing publishes on debriefing.io about named companies, newest first. Each brief is dated and every finding cites a public source. Filter by words in the brief and by company name, slug, or domain. With no arguments, lists the newest briefs. Needs no Debriefing account. Returns the page URL of each brief.

Arguments

query string
Words to find in the brief, such as pricing or launch
company string
A company name, slug, or domain, such as Crayon or crayon.co
limit integer

Example call

{
  "query": "pricing",
  "company": "Crayon",
  "limit": 5
}

Example result

{
  "items": [
    {
      "title": "Crayon competitive brief, 28 September 2026",
      "company_name": "Crayon",
      "company_slug": "crayon",
      "slug": "2026-09-28",
      "coverage_start_on": "2026-09-14",
      "coverage_end_on": "2026-09-28",
      "published_on": "2026-09-29",
      "updated_on": "2026-09-29",
      "finding_count": 3,
      "url": "https://debriefing.io/briefs/crayon/2026-09-28"
    }
  ],
  "briefs_url": "https://debriefing.io/briefs",
  "free_brief": {
    "url": "https://debriefing.io/?utm_campaign=public_tools&utm_content=search_public_briefs&utm_medium=ai_assistant&utm_source=mcp",
    "text": "Debriefing writes a free competitive brief about the competitors you pick, with every finding linked to its source."
  }
}

get_public_brief no sign-in Gets one competitive brief that Debriefing published on debriefing.io: the summary, each finding with its category and date, and the numbered public sources with their URLs. Name the brief by its URL, or by company_slug and slug from search_public_briefs. With company_slug only, gets the newest brief about that company. Needs no Debriefing account.

Arguments

url string
The brief URL, such as https://debriefing.io/briefs/crayon/2026-09-28
company_slug string
The company part of the brief URL, such as crayon
slug string
The date part of the brief URL, such as 2026-09-28

Example call

{
  "company_slug": "crayon",
  "slug": "2026-09-28"
}

Example result

{
  "title": "Crayon competitive brief, 28 September 2026",
  "company": {
    "name": "Crayon",
    "domain": "crayon.co",
    "website_url": "https://www.crayon.co"
  },
  "summary": [
    "Crayon moved its entry plan behind a sales call."
  ],
  "findings": [
    {
      "title": "Crayon removed published pricing",
      "category": "pricing",
      "first_seen_on": "2026-09-22",
      "source_numbers": [
        1
      ]
    }
  ],
  "sources": [
    {
      "number": 1,
      "title": "Crayon pricing",
      "url": "https://www.crayon.co/pricing",
      "observed_on": "2026-09-22"
    }
  ],
  "url": "https://debriefing.io/briefs/crayon/2026-09-28",
  "markdown_url": "https://debriefing.io/briefs/crayon/2026-09-28.md",
  "free_brief": {
    "url": "https://debriefing.io/?utm_campaign=public_tools&utm_content=get_public_brief&utm_medium=ai_assistant&utm_source=mcp",
    "text": "Debriefing writes a free competitive brief about the competitors you pick, with every finding linked to its source."
  }
}

search_guides no sign-in Searches the public competitive intelligence library on debriefing.io: how-to guides, glossary terms, tool comparisons, alternatives pages, company profiles, and market intel posts. Returns the title, a short excerpt, and the page URL of each match, best match first. Needs no Debriefing account.

Arguments

query string · required
Words to find, such as battlecard or win-loss interview
collection string
Only search one part of the library
limit integer

Example call

{
  "query": "battlecard",
  "limit": 3
}

Example result

{
  "items": [
    {
      "title": "How to create battlecards",
      "collection": "guides",
      "excerpt": "A battlecard is a one-page brief that…",
      "updated_on": "2026-09-01",
      "url": "https://debriefing.io/guides/how-to-create-battlecards"
    }
  ],
  "free_brief": {
    "url": "https://debriefing.io/?utm_campaign=public_tools&utm_content=search_guides&utm_medium=ai_assistant&utm_source=mcp",
    "text": "Debriefing writes a free competitive brief about the competitors you pick, with every finding linked to its source."
  }
}

get_free_brief_link no sign-in Gets the debriefing.io links where a person requests a free competitive brief about their own company and competitors, signs up for a workspace, or compares plans. It only returns links. It sends nothing and creates nothing.

No arguments.

Example result

{
  "free_brief_url": "https://debriefing.io/?utm_campaign=public_tools&utm_content=get_free_brief_link&utm_medium=ai_assistant&utm_source=mcp",
  "sign_up_url": "https://debriefing.io/sign_up",
  "pricing_url": "https://debriefing.io/pricing",
  "what_you_get": "Enter your company website and the competitors you want to watch. Debriefing researches them and emails a brief…",
  "connect_url": "https://debriefing.io/developers?tab=mcp"
}

Brief me on one competitor

Use get_competitor for Acme, then search_signals for that competitor from the last 14 days. Cite the evidence URLs.

What moved this week?

List digests of type daily_digest, open the newest one, and summarize what matters for our sales team.

Prep a call

Get the battlecard for competitor_id 42. Pull the three highest-severity open signals. Give me talk tracks grounded in the evidence.

Trace a claim

Search signals for pricing changes. For the top result, call get_evidence and show me each source excerpt with its URL.

Catch up and act

Call what_changed since Monday. Pin the most important signal for the team and add a talking point on what sales should say about it.

No account yet

Search Debriefing's public briefs for Crayon and summarize the newest one with its sources. Then find the Debriefing guide on battlecards.

Add a competitor

Check get_plan_and_limits for a free competitor slot. If there is one, add northwind.example to the watchlist and start its research.

401 Unauthorized

The key or the sign-in is missing, wrong, or revoked. Claude and ChatGPT ask you to sign in again. For a key, create a new one in Settings, then Integrations.
A tool says it needs a paid plan

Any workspace can connect. Signals, digests, and battlecards read in full on a paid plan and in the free first week. Some changes need a paid plan, as in the app. The answer has the pricing link. Upgrade, then retry with the same connection.
A tool says the connection may not make changes

The connection lacks the write or spend scope. Disconnect Debriefing in the client, connect again, and tick Write or Spend on the consent screen.
429 Too many requests

Each connection may send 120 requests a minute, and each address 600. Wait a minute, then retry.
Claude or ChatGPT cannot connect

Check the URL: https://debriefing.io/mcp. Sign in to Debriefing in the same browser, then connect again. If the consent screen shows no Approve button, finish setting up the workspace first.
Disconnect an app

An admin opens Organization settings, then Integrations, and selects Disconnect next to the app. Access ends at once.
Tools do not appear

Restart the client after you save the config. Confirm Node.js 18+ is on the PATH when you use mcp-remote.
Header mangled on Windows or Cursor

Do not put spaces inside the args string for Authorization. Use Authorization:${AUTH_HEADER} and put Bearer dbk_… in the env value.
GET /mcp returns 405

This server answers POST only. It does not stream over SSE. Clients must use Streamable HTTP or mcp-remote.