Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Clarify MCP connector

OAuth 2.0 crmproductivityanalyticssales

Connect to Clarify MCP to manage CRM records, leads, campaigns, lists, and analytics directly from your AI workflows.

Clarify MCP connector

  1. Install the SDK

    Section titled “Install the SDK”
    Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Set your credentials

    Section titled “Set your credentials”

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>

  3. Authorize and make your first call

    Section titled “Authorize and make your first call”
    quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    

    const scalekit = new ScalekitClient(
      process.env.SCALEKIT_ENV_URL,
      process.env.SCALEKIT_CLIENT_ID,
      process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    

    const connector = 'clarifymcp'
    const identifier = 'user_123'
    

    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Clarify MCP:', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    

    // Make your first call
    const result = await actions.executeTool({
      connector,
      identifier,
      toolName: 'clarifymcp_get_campaigns',
      toolInput: {},
    })
    console.log(result)

What you can do

Section titled “What you can do”

Connect this agent connector to let your agent:

  • Manage CRM records — create, update, delete, and query records across any custom object type
  • Manage campaigns — create, update, delete, and list outreach campaigns with multi-step email sequences
  • Find and import leads — search for leads by criteria and import them into campaigns or lists
  • Manage lists and segments — create, update, delete, and list audience lists for targeting
  • Extend the data model — create, update, and delete custom objects and fields to match your schema
  • Analyze and query data — run analytics queries and retrieve structured data with custom filters

Tool list

Section titled “Tool list”

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

clarifymcp_add_comment # Add a Markdown comment to a supported Clarify entity (deal, person, company, etc.). 3 params

Add a Markdown comment to a supported Clarify entity (deal, person, company, etc.).

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
id string required The unique ID of the record (e.g. per_01ABCDE for a person, cmp_01ABCDE for a company).
message string required The comment text in Markdown format. Supports **bold**, *italic*, and bullet lists.
clarifymcp_create_or_update_campaign # Create a new email campaign or update an existing one by its ID. 4 params

Create a new email campaign or update an existing one by its ID.

Name Type Required Description
campaign_name string required Name of the campaign. Required when creating a new campaign.
email_steps array required Array of email step definitions for the campaign sequence.
campaign_id string optional ID of an existing campaign to update. Omit to create a new campaign.
status string optional Campaign status — draft (default) or active.
clarifymcp_create_or_update_custom_object # Create a new custom object type or update an existing one in the Clarify workspace. 4 params

Create a new custom object type or update an existing one in the Clarify workspace.

Name Type Required Description
description string optional AI context description for this object type — helps the AI understand when to use it.
entity string optional The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
name string optional Display name for the custom object type. Will be normalized to a slug for the entity identifier.
plural string optional Plural label for the custom object type (e.g. Partnerships for a singular Partnership).
clarifymcp_create_or_update_fields # Create new custom fields or update existing fields on any Clarify entity (person, company, deal, or custom object). 2 params

Create new custom fields or update existing fields on any Clarify entity (person, company, deal, or custom object).

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
fields array required Array of field definitions to create or update on the entity.
clarifymcp_create_or_update_list # Create or update a dynamic list — a saved view whose membership is defined by a SQL query. 6 params

Create or update a dynamic list — a saved view whose membership is defined by a SQL query.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
description string optional AI context description for this list — helps the AI understand when to use it.
emoji string optional A single emoji to display alongside the list name.
list_id string optional The ID of an existing list (saved view). Use get_lists to find available list IDs.
sql string optional SQL query to execute. For query_data use PostgreSQL syntax; for query_analytics use ClickHouse SQL.
title string optional The display name of the list.
clarifymcp_create_or_update_records # Create new records or update existing ones in Clarify. Supports bulk operations of up to 25 records per call. 2 params

Create new records or update existing ones in Clarify. Supports bulk operations of up to 25 records per call.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
records array required Array of records to create or update. Each item contains an attributes object with field values.
clarifymcp_delete_campaign # Permanently delete an email campaign by its ID. 1 param

Permanently delete an email campaign by its ID.

Name Type Required Description
campaign_id string required The ID of the campaign. Use get_campaigns to list available campaigns and their IDs.
clarifymcp_delete_custom_object # Permanently delete a custom object type from the Clarify workspace by its entity identifier. 1 param

Permanently delete a custom object type from the Clarify workspace by its entity identifier.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
clarifymcp_delete_fields # Permanently delete one or more custom fields from a Clarify entity by their field slugs. 2 params

Permanently delete one or more custom fields from a Clarify entity by their field slugs.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
fieldNames array required Array of field slugs (snake_case) to delete from the entity.
clarifymcp_delete_list # Permanently delete a saved list (dynamic view) by its ID. 2 params

Permanently delete a saved list (dynamic view) by its ID.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
list_id string required The ID of an existing list (saved view). Use get_lists to find available list IDs.
clarifymcp_delete_records # Permanently delete one or more records by their IDs. Supports bulk deletion of up to 25 records per call. 2 params

Permanently delete one or more records by their IDs. Supports bulk deletion of up to 25 records per call.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
record_ids array required Array of record IDs to delete. All must belong to the same entity type.
clarifymcp_find_leads # Search Clarify's built-in prospect database of 28M+ companies and 175M+ people to find new leads. 4 params

Search Clarify's built-in prospect database of 28M+ companies and 175M+ people to find new leads.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
search_label string required A descriptive label for this lead search (e.g. SF SaaS Companies 50+ employees).
sql string required SQL query to execute. For query_data use PostgreSQL syntax; for query_analytics use ClickHouse SQL.
search_identifiers string optional Optional: provide a prior searchId and versionId to operate on an existing search.
clarifymcp_get_campaigns # List email campaigns in the workspace, or fetch a single campaign by ID with full details. 5 params

List email campaigns in the workspace, or fetch a single campaign by ID with full details.

Name Type Required Description
campaign_id string optional The ID of the campaign. Use get_campaigns to list available campaigns and their IDs.
limit number optional Maximum number of records to return per page.
offset number optional Number of records to skip for pagination (use with limit).
search string optional Case-insensitive substring search to filter results by name or title.
status string optional Filter by campaign status — draft (unpublished) or active (live campaigns).
clarifymcp_get_current_user # Retrieve information about the currently authenticated Clarify user, including timezone and workspace details. 1 param

Retrieve information about the currently authenticated Clarify user, including timezone and workspace details.

Name Type Required Description
mcp_client_timezone string optional Your IANA timezone string (e.g. America/New_York). Helps Clarify show times in your local timezone.
clarifymcp_get_lists # List saved views (dynamic lists) for an entity type, or fetch a single list by ID. 5 params

List saved views (dynamic lists) for an entity type, or fetch a single list by ID.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
limit number optional Maximum number of records to return per page.
list_id string optional The ID of an existing list (saved view). Use get_lists to find available list IDs.
offset number optional Number of records to skip for pagination (use with limit).
search string optional Case-insensitive substring search to filter results by name or title.
clarifymcp_get_records # Retrieve full details for one or more Clarify records by their IDs. 2 params

Retrieve full details for one or more Clarify records by their IDs.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
ids array required Array of record IDs to retrieve. Use query_data to find IDs first.
clarifymcp_get_schema # Retrieve the schema for Clarify entities, including field definitions and relationship metadata. 2 params

Retrieve the schema for Clarify entities, including field definitions and relationship metadata.

Name Type Required Description
entities array optional List of entity types to get schema for. Omit to return the schema for all entities.
format string optional Schema format — use read for querying data or write for creating/updating records.
clarifymcp_import_leads # Import leads from a find_leads search result into your Clarify workspace. 7 params

Import leads from a find_leads search result into your Clarify workspace.

Name Type Required Description
searchEmoji string required A single emoji representing the theme of the search.
searchId string required The ID of the lead search returned by find_leads.
searchTitle string required A descriptive title for the search based on its filters.
sourceEntity string required The lead entity type to import from — tam_company or tam_person.
count integer optional Number of leads to import. Omit to import all leads in the search.
extraFields array optional Additional TAM field names to import beyond the default fields.
versionId string optional The version ID of the search. Use the versionId from a prior find_leads result when available.
clarifymcp_merge_records # Merge two or more duplicate records into a single primary record, combining all data. 3 params

Merge two or more duplicate records into a single primary record, combining all data.

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
primaryRecordId string required The ID of the record to keep after the merge — all data is merged into this record.
sourceRecordIds array required IDs of records to merge into the primary record. These records are deleted after merging.
clarifymcp_query_analytics # Execute a read-only ClickHouse SQL query against the Clarify analytics event log. 2 params

Execute a read-only ClickHouse SQL query against the Clarify analytics event log.

Name Type Required Description
sql string required SQL query to execute. For query_data use PostgreSQL syntax; for query_analytics use ClickHouse SQL.
limit number optional Maximum number of records to return per page.
clarifymcp_query_data # Execute a read-only PostgreSQL query against Clarify CRM data (contacts, companies, deals, etc.). 4 params

Execute a read-only PostgreSQL query against Clarify CRM data (contacts, companies, deals, etc.).

Name Type Required Description
entity string required The entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).
sql string required SQL query to execute. For query_data use PostgreSQL syntax; for query_analytics use ClickHouse SQL.
limit number optional Maximum number of records to return per page.
offset number optional Number of records to skip for pagination (use with limit).
clarifymcp_submit_feedback # Submit a feature request or bug report about Clarify MCP tools. 2 params

Submit a feature request or bug report about Clarify MCP tools.

Name Type Required Description
feedback string required The feature request or feedback message describing what is missing or broken.
category string optional Category for your feedback. Accepted values: missing_tool, bug, improvement, other.