Other

Changelog

API changes and versioning policy.

2026-03-10 — Insights & Alerts Tools (16 → 21 tools)

  • 5 new tools exposing core product features to MCP, REST, and OpenAPI clients:
    • get_ai_visibility_score — The core brand metric (0–100) with factor breakdown, issue counts, and change tracking.
    • get_dashboard_overview — Company-wide KPIs: average score, brand count, open/critical issues, unread notifications, and empty-state flags.
    • list_simulations — Recent AI simulation sessions showing platform, query, score, and status.
    • get_competitor_rankings — Competitive intelligence with rankings, scores, and rank change direction. Filterable by brand and platform.
    • list_notifications — Alerts for bot access, crawler errors, content gaps, AI mentions, and system events. Filterable to unread only.
  • All 5 new tools are read-only and require no additional scopes beyond a valid API key.
  • CLI v2.1.0: New commands score, dashboard, simulations, rankings, notifications.
  • OpenAPI spec auto-updated — no action needed for ChatGPT Actions consumers.

2026-02-19 — Feature Coverage Gaps

  • New tool: get_agent_run_summary — now exposed in the external API (MCP, REST, OpenAPI). Returns totalRuns, successfulRuns, failedRuns, averageDurationMs, and lastRunAt for a given agent instance.
  • CLI: brands competitors <id> — list competitors for a brand (closes the last CLI coverage gap).
  • CLI: agents summary <instanceId> — view agent run statistics from the command line.

2026-02-19 — REST Endpoints, OpenAPI Spec & Agent DX

  • REST endpoints: Every tool is now available as POST /api/mcp-app/rest/{tool_name} with a plain JSON body and unwrapped JSON responses. No JSON-RPC required.
  • OpenAPI 3.1.0 spec: Auto-generated at GET /api/mcp-app/openapi.json. Importable directly into ChatGPT Custom GPT Actions.
  • _hint on errors: Tool validation errors now include a _hint field with actionable guidance (e.g., "Call list_brand_profiles first to get available brand IDs").
  • Per-key rate limit overrides: API keys can now have custom rate limits via scopes.rateLimit (1–600 req/min, default 60).

2026-02-19 — Brand Name Resolution & Ping

  • Brand name resolution: All tools that accept brandId now accept a brand name (e.g., "Ace Auto Repair") in addition to a UUID. The server resolves the name to a UUID automatically via exact case-insensitive match.
  • ping method: New lightweight health-check method. No authentication required. Returns {}.
  • Improved error messages: Tool errors now include the tool name (e.g., Tool 'get_brand_profile' failed: ...) for easier debugging.
  • Updated brandId descriptions across all tool schemas and documentation.

2026-02-18 — Initial Documentation Release

  • Published documentation for the SocialCRM MCP API.
  • 15 tools available:
    • Brand & Analytics (9): list_brand_profiles, get_brand_profile, get_competitors, get_repository_items, search_repository_items, get_platform_metrics, get_brand_mentions, get_monitoring_results, get_metric_trend
    • Workflow (6): list_workflows, get_credits, run_workflow, get_run_status, list_workflow_runs, cancel_workflow_run
  • Endpoint: POST https://socialcrm.com/api/mcp-app
  • Auth: Bearer token with sk_live_ API keys
  • Rate limits: 60 req/min general, 10 req/min mutating

Versioning Policy

The SocialCRM API is currently unversioned — there is a single live endpoint. We commit to the following:

  • Non-breaking changes (new tools, new optional fields, new optional parameters) are shipped without notice.
  • Breaking changes (removing tools, renaming fields, changing required parameters) will be communicated at least 30 days in advance via email to all API key holders.
  • This changelog will be updated with every material change to the API.