Tool Reference

Tools Overview

Summary of all 29 SocialCRM API tools for brand data, prompt sets, reusable agents, insights, and workflow execution.

The SocialCRM connector exposes 29 tools across five groups: Brand & Analytics, Insights & Alerts, Prompt Sets, Workflows, and Reusable Agents.

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 core benchmarked engines brandId
get_brand_mentions Get recent mentions from recorded AI engine checks 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

Prompt Set Tools (3)

Tool Description Required Params Mutating
list_prompt_sets List company prompt sets (none) No
list_tracked_prompts List prompts in a set promptSetId No
add_prompts_to_set Add up to 20 durable prompts, skipping exact duplicates promptSetId, prompts Yes

In the MVP, a prompt set is scoped to a SocialCRM brand. Prompts are stored as company- and brand-scoped ai_tests records, so they remain available outside the connector conversation.

Reusable Agent Tools (4)

Tool Description Required Params Mutating
list_reusable_agents List saved company agents (none) No
create_reusable_agent Configure and persist a guarded specialist agent name, archetype, instructions Yes
run_reusable_agent Queue a run for a saved agent agentId Yes
get_agent_run_status Read persisted run status and output runId No

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, add_prompts_to_set, create_reusable_agent, and run_reusable_agent) require socialcrm.write and are subject to a stricter rate limit of 10 requests/minute. See Errors & Rate Limiting.