Clarify MCP connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. 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

   Node.js

   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)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "clarifymcp"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Clarify MCP:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="clarifymcp_get_campaigns",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

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

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.).

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

idstringrequiredThe unique ID of the record (e.g. per_01ABCDE for a person, cmp_01ABCDE for a company).

messagestringrequiredThe 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.

NameTypeRequiredDescription

campaign_namestringrequiredName of the campaign. Required when creating a new campaign.

email_stepsarrayrequiredArray of email step definitions for the campaign sequence.

campaign_idstringoptionalID of an existing campaign to update. Omit to create a new campaign.

statusstringoptionalCampaign 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.

NameTypeRequiredDescription

descriptionstringoptionalAI context description for this object type — helps the AI understand when to use it.

entitystringoptionalThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

namestringoptionalDisplay name for the custom object type. Will be normalized to a slug for the entity identifier.

pluralstringoptionalPlural 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).

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

fieldsarrayrequiredArray 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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

descriptionstringoptionalAI context description for this object type — helps the AI understand when to use it.

emojistringoptionalA single emoji to display alongside the list name.

list_idstringoptionalThe ID of an existing list (saved view). Use get_lists to find available list IDs.

sqlstringoptionalSQL query to execute. For query_data use PostgreSQL syntax; for query_analytics use ClickHouse SQL.

titlestringoptionalThe 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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

recordsarrayrequiredArray 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.

NameTypeRequiredDescription

campaign_idstringrequiredThe 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.

NameTypeRequiredDescription

entitystringrequiredThe 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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

fieldNamesarrayrequiredArray 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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

list_idstringrequiredThe 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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

record_idsarrayrequiredArray 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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

search_labelstringrequiredA descriptive label for this lead search (e.g. SF SaaS Companies 50+ employees).

sqlstringrequiredSQL query to execute. For query_data use PostgreSQL syntax; for query_analytics use ClickHouse SQL.

search_identifiersstringoptionalOptional: 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.

NameTypeRequiredDescription

campaign_idstringoptionalThe ID of the campaign. Use get_campaigns to list available campaigns and their IDs.

limitnumberoptionalMaximum number of records to return per page.

offsetnumberoptionalNumber of records to skip for pagination (use with limit).

searchstringoptionalCase-insensitive substring search to filter results by name or title.

statusstringoptionalFilter 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.

NameTypeRequiredDescription

mcp_client_timezonestringoptionalYour 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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

limitnumberoptionalMaximum number of records to return per page.

list_idstringoptionalThe ID of an existing list (saved view). Use get_lists to find available list IDs.

offsetnumberoptionalNumber of records to skip for pagination (use with limit).

searchstringoptionalCase-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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

idsarrayrequiredArray 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.

NameTypeRequiredDescription

entitiesarrayoptionalList of entity types to get schema for. Omit to return the schema for all entities.

formatstringoptionalSchema 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.

NameTypeRequiredDescription

searchEmojistringrequiredA single emoji representing the theme of the search.

searchIdstringrequiredThe ID of the lead search returned by find_leads.

searchTitlestringrequiredA descriptive title for the search based on its filters.

sourceEntitystringrequiredThe lead entity type to import from — tam_company or tam_person.

countintegeroptionalNumber of leads to import. Omit to import all leads in the search.

extraFieldsarrayoptionalAdditional TAM field names to import beyond the default fields.

versionIdstringoptionalThe 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.

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

primaryRecordIdstringrequiredThe ID of the record to keep after the merge — all data is merged into this record.

sourceRecordIdsarrayrequiredIDs 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.

NameTypeRequiredDescription

sqlstringrequiredSQL query to execute. For query_data use PostgreSQL syntax; for query_analytics use ClickHouse SQL.

limitnumberoptionalMaximum 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.).

NameTypeRequiredDescription

entitystringrequiredThe entity type to operate on (e.g. person, company, deal, or a custom object identifier like c_my_object).

sqlstringrequiredSQL query to execute. For query_data use PostgreSQL syntax; for query_analytics use ClickHouse SQL.

limitnumberoptionalMaximum number of records to return per page.

offsetnumberoptionalNumber 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.

NameTypeRequiredDescription

feedbackstringrequiredThe feature request or feedback message describing what is missing or broken.

categorystringoptionalCategory for your feedback. Accepted values: missing_tool, bug, improvement, other.