DocsAPI and MCP
Local Intelligence

API and MCP

The businesses near you in Claude, ChatGPT or your own code: this week's brief, each competitor's Google Maps rank, reviews, offers and ads, and every past brief. Separate from the other Alertedly APIs: their keys don't work here, and ours don't work there.

Access and plans

  • MCP (Claude, ChatGPT, Cursor, any MCP client) is on every plan. People connect by signing in with their Alertedly account and see the workspaces they belong to.
  • REST is on Pro. Integrations use an API key (alyl_live_…) that an admin creates under Settings → API keys. A key belongs to one workspace: read, or read and write.
  • Send keys as X-API-Key: alyl_live_… or Authorization: Bearer alyl_live_…. People in several workspaces pick one with X-Workspace-Id (REST) or the tools' workspace argument (MCP).
  • Without the plan the answer is 402 PLAN_REQUIRED with an upgrade_url, your workspace's settings.

MCP server

MCP server URL
https://local.alertedly.com/mcp

Streamable HTTP. In Claude: Settings → Connectors → Add custom connector, paste the URL and sign in. In ChatGPT: Open chatgpt.com/plugins, then + → Add custom MCP server: paste the server URL, choose OAuth, and sign in with your Alertedly account when asked. In Cursor: add this to ~/.cursor/mcp.json and sign in when Cursor asks. Name a competitor by its id, website or name.

Cursor: mcp.json
{
  "mcpServers": {
    "alertedly-local": {
      "url": "https://local.alertedly.com/mcp"
    }
  }
}
  • Tool
    get_overview
    Access
    read
    What it does
    The latest weekly brief: headline, the moves to make first, your business and every competitor (Maps rank per search, rating, new reviews, complaints, offers, ads), with what changed since last week.
  • Tool
    get_competitor_brief
    Access
    read
    What it does
    One competitor's part of the latest brief, and the opening it leaves you.
  • Tool
    list_competitors
    Access
    read
    What it does
    The businesses you track, your own business, and your plan's limit.
  • Tool
    add_competitor
    Access
    write
    What it does
    Track a local business by its website. It is found on Google Maps within minutes and is in every weekly brief after.
  • Tool
    remove_competitor
    Access
    write
    What it does
    Stop tracking a competitor. Past briefs stay.
  • Tool
    list_reports
    Access
    read
    What it does
    Every weekly brief on file, newest first.
  • Tool
    get_report
    Access
    read
    What it does
    One weekly brief, with every fact it was written from.
  • Tool
    get_settings
    Access
    read
    What it does
    Workspace name, where the brief is emailed, and the Google searches whose Maps ranking is watched.
  • Tool
    update_settings
    Access
    write
    What it does
    Rename the workspace, change the brief email, or replace the searches watched (admins).
  • Tool
    get_plan
    Access
    read
    What it does
    Your plan, its limits, what it opens (MCP, REST) and the upgrade link.
  • Tool
    list_team
    Access
    read
    What it does
    Members and pending invites.
  • Tool
    invite
    Access
    write
    What it does
    Invite a teammate by email (admins).
  • Tool
    remove_member
    Access
    write
    What it does
    Remove a teammate or cancel an invite (admins).
  • Tool
    list_api_keys
    Access
    read
    What it does
    Live API keys, never the key itself (admins).
  • Tool
    create_api_key
    Access
    write
    What it does
    A new API key, shown once (admins).
  • Tool
    revoke_api_key
    Access
    write
    What it does
    Revoke an API key (admins).

Try: “What changed in my market this week?”, “Who is ranking above me on Google Maps?”, “Which competitor got the most new reviews?”, “Track acmeheating.com”.

REST API

Base URL
https://local.alertedly.com/api/v1
Example
curl "https://local.alertedly.com/api/v1/overview" -H "X-API-Key: alyl_live_…"
  • Method
    GET
    Path
    /usage
    Scope
    read
    What
    Plan, limits, access, calls this month
  • Method
    GET
    Path
    /plan
    Scope
    read
    What
    Your plan, read-only
  • Method
    GET
    Path
    /overview
    Scope
    read
    What
    The latest weekly brief across your market
  • Method
    GET
    Path
    /competitors
    Scope
    read
    What
    Competitors you track
  • Method
    POST
    Path
    /competitors
    Scope
    write
    What
    {"website"}: track a competitor
  • Method
    GET
    Path
    /competitors/{id}/brief
    Scope
    read
    What
    One competitor's part of the latest brief
  • Method
    DELETE
    Path
    /competitors/{id}
    Scope
    write
    What
    Stop tracking a competitor
  • Method
    GET
    Path
    /reports
    Scope
    read
    What
    Weekly briefs, newest first
  • Method
    GET
    Path
    /reports/{id}
    Scope
    read
    What
    One brief (markdown and HTML)
  • Method
    GET
    Path
    /settings
    Scope
    read
    What
    Settings
  • Method
    PATCH
    Path
    /settings
    Scope
    write
    What
    {"name"?, "brief_email"?, "searches"?}: change settings (admins)
  • Method
    GET
    Path
    /team
    Scope
    read
    What
    Members and invites
  • Method
    POST
    Path
    /team/invites
    Scope
    write
    What
    {"email", "role"}: invite (admins)
  • Method
    DELETE
    Path
    /team/members/{id}
    Scope
    write
    What
    Remove a member or cancel an invite (admins)
  • Method
    GET
    Path
    /api-keys
    Scope
    read
    What
    Live API keys (admins)
  • Method
    POST
    Path
    /api-keys
    Scope
    write
    What
    {"name", "scopes"}: a new key, shown once (admins)
  • Method
    DELETE
    Path
    /api-keys/{id}
    Scope
    write
    What
    Revoke a key (admins)

Limits and errors

  • 60 requests a minute per key or person; over it, 429 with Retry-After.
  • Errors are { error: { message, error_code }, request_id }: UNAUTHORIZED, PLAN_REQUIRED, INSUFFICIENT_SCOPE, ADMIN_REQUIRED, NOT_FOUND, REFUSED (with the reason), RATE_LIMITED.
  • The brief is written once a week; the numbers are from the latest weekly run.