Tool Reference

Tools Overview

Summary of all 21 SocialCRM API tools for brand data, insights, and workflow execution.

The SocialCRM API exposes 21 tools split into three groups: Brand & Analytics tools for reading brand data, Insights & Alerts tools for scores, simulations, and notifications, and Workflow tools for running automated multi-agent processes.

All tools are invoked via tools/call with the tool name and arguments. See the Protocol doc for the full request format.

Brand & Analytics Tools (10)

Tool Description Required Params
list_brand_profiles List all brand profiles for your company (none)
get_brand_profile Get detailed information about a specific brand profile brandId
get_competitors Get the list of competitors for a brand brandId
get_repository_items Get content items from the brand repository brandId
search_repository_items Search for content items in the brand repository brandId, query
get_platform_metrics Get visibility and engagement metrics across AI platforms brandId
get_brand_mentions Get recent mentions of a brand across AI platforms brandId
get_monitoring_results Get the latest monitoring script results for a brand brandId
get_metric_trend Get historical trend data for a specific metric brandId, metricName
get_agent_run_summary Get execution statistics for an agent instance agentInstanceId

Insights & Alerts Tools (5) — NEW

Tool Description Required Params
get_ai_visibility_score Get the AI visibility score for a brand (0–100) brandId
get_dashboard_overview Get company-wide KPIs: score, issues, notifications (none)
list_simulations List recent AI simulation sessions (none)
get_competitor_rankings Get competitive intelligence rankings (none)
list_notifications List recent notifications and alerts (none)

Workflow Tools (6)

Tool Description Required Params Mutating
list_workflows List all available workflows with costs and availability (none) No
get_credits Get current credit balance and usage (none) No
run_workflow Start a workflow run (async) workflowId Yes
get_run_status Get the full status of a workflow run runId No
list_workflow_runs List recent workflow runs with optional filtering (none) No
cancel_workflow_run Cancel a pending or running workflow run runId Yes

Parameter Conventions

  • brandId — The UUID or name of a brand profile. You can pass a human-readable brand name (e.g., "Ace Auto Repair") and the server resolves it automatically. Call list_brand_profiles to discover your brands.
  • companyId — Auto-injected from your API key. This parameter does not appear in tool schemas and should never be passed.
  • runId — The UUID of a workflow run, returned by run_workflow.
  • Mutating tools (run_workflow, cancel_workflow_run) are subject to a stricter rate limit of 10 requests/minute. See Errors & Rate Limiting.