Skip to main content
Glama

Cirra AI Salesforce Admin MCP Server

Server Details

Comprehensive Salesforce administration and data management capabilities

Status
Healthy
Last Tested
Transport
Streamable HTTP
URL

Glama MCP Gateway

Connect through Glama MCP Gateway for full control over tool access and complete visibility into every call.

MCP client
Glama
MCP server

Full call logging

Every tool call is logged with complete inputs and outputs, so you can debug issues and audit what your agents are doing.

Tool access control

Enable or disable individual tools per connector, so you decide what your agents can and cannot do.

Managed credentials

Glama handles OAuth flows, token storage, and automatic rotation, so credentials never expire on your clients.

Usage analytics

See which tools your agents call, how often, and when, so you can understand usage patterns and catch anomalies.

100% free. Your data is private.

Tool Definition Quality

Score is being calculated. Check back soon.

Available Tools

40 tools
cirra_ai_init
Read-onlyIdempotent
Inspect

IMPORTANT: call cirra_ai_init before calling any other tools of the Cirra AI MCP server. You MUST carefully read the instructions returned from this tool call before proceeding

ParametersJSON Schema
NameRequiredDescriptionDefault
scopeNo(optional) Controls whether the provided `cirra_ai_team` and/or `sf_user` apply only to this chat (`thread`) or are saved as new defaults for future (`global`). Only use 'thread' if explicitly instructed by the user. Leave blank if not switching team or connection.global
sf_userNo(optional) A Salesforce username identifying the Salesforce connection to use. Omit this to use the current default connection.
cirra_ai_teamNo(optional) The Cirra AI team to use. Use the literal value `__Personal__` to select the user's personal account. Omit this to use the previously selected default team (if any).
fetch_moreA
Read-onlyIdempotent
Inspect

Fetch the next page of a large tool response. Use the nextCursor from _pagination in a previous response. This tool loads data into the context window — prefer the artifact download URL when available.

ParametersJSON Schema
NameRequiredDescriptionDefault
cursorYesPagination cursor from _pagination.nextCursor
pageSizeNo(optional) Number of records to return in this page. If omitted, uses the page size from the original query.
artifactIdYesArtifact ID from instructions.artifactId
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations declare readOnly/idempotent/destructive hints, so safety is covered. Description adds valuable behavioral context: 'loads data into the context window' explains the side effect/mechanism, and clarifies the cursor source. Does not contradict annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences with zero waste: (1) purpose, (2) required input source, (3) alternative preference. Front-loaded with action verb 'Fetch'. Every clause earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-purpose pagination helper with 100% schema coverage and clear annotations, the description is complete. It explains the mechanism (context window loading), prerequisites (previous response cursor), and alternatives (artifact URL) without needing output schema details.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% (baseline 3). Description adds semantic context by linking 'cursor' to '_pagination.nextCursor' and 'artifactId' to the 'artifact download URL' alternative, helping the agent understand the relationship between parameters and the pagination workflow.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States specific action ('Fetch the next page') and resource ('large tool response'). Clearly distinguishes from CRUD siblings (sobject_create, soql_query, etc.) by identifying itself as a pagination utility rather than a Salesforce operation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states prerequisite ('Use the nextCursor from _pagination in a previous response') and provides clear alternative guidance ('prefer the artifact download URL when available'), helping the agent decide between pagination and direct download.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

group_createInspect

Create a new public group, queue or role in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
nameYesThe name for the group
typeYesThe type of group to create
labelNoThe label for the group. Will be generated from the name if not provided.
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
propertiesNoAdditional properties for the group
descriptionYesThe description for the group
supportedObjectsNoThe objects that the queue can access
group_membersA
Destructive
Inspect

Add or remove users from public groups, queues, or roles in Salesforce.

ParametersJSON Schema
NameRequiredDescriptionDefault
usersYesThe names, usernames or IDs of the users
groupsYesThe names, labels or IDs of the public groups, queues or roles
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
operationYesThe operation to perform: 'add' to add users to groups, 'remove' to remove users from groups
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description aligns with annotations (mentions 'remove' matching destructiveHint=true) and adds specific entity context (queues, roles) beyond the tool name. However, it omits behavioral details beyond annotations, such as failure modes for invalid user IDs or whether partial successes occur.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single efficient sentence with zero waste. Every element earns its place: the dual operation verbs, target resources, specific entity types (distinguishing groups/queues/roles), and scope.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the rich schema (100% coverage) and comprehensive annotations (destructive, non-idempotent hints), the description provides sufficient context for tool selection. It appropriately handles the complexity of batch membership operations without requiring output schema details.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the baseline is 3. The description doesn't add syntax details or format examples for parameters (e.g., ID formats), but accurately reflects the dual operation nature (add/remove) specified in the operation enum.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action (Add or remove), the target resource (users), the destination entities (public groups, queues, or roles), and the system (Salesforce). This effectively distinguishes it from sibling tools like group_create or group_update which manage the groups themselves rather than membership.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage by specifying the operation type (membership management) and target entity types, but lacks explicit guidance on when to choose this over user_update or permission_set_assignments, and doesn't mention prerequisites like admin permissions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

group_update
Idempotent
Inspect

Update a public group or queue in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
groupYesThe name or ID of the public group or queue.
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
propertiesYesProperties to update
metadata_createInspect

Create one or more Salesforce metadata elements of a specified type, such as custom fields, validation rules, or custom labels

ParametersJSON Schema
NameRequiredDescriptionDefault
typeYesThe metadata type.
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
metadataYesThe array of metadata records to create. Each record must include at least a 'fullName' property
metadata_delete
Destructive
Inspect

Delete one or more Salesforce metadata elements of a specified type, such as custom fields, validation rules, or custom labels. Maximum is 10 per batch - DO NOT EXCEED.

ParametersJSON Schema
NameRequiredDescriptionDefault
typeYesThe metadata type.
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
fullNamesYesThe full name(s) of the metadata element(s) to delete.
metadata_describe
Read-onlyIdempotent
Inspect

List all Salesforce metadata types available in the org and their properties, such as directory name, suffix, and child objects

ParametersJSON Schema
NameRequiredDescriptionDefault
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
verboseYesIf false or missing, return only the names of the metadata types. This is the default. If true, return additional properties for each type.
pageSizeNo(optional) Maximum number of records to return per page when the response requires pagination. If omitted, page size is calculated automatically.
metadata_list
Read-onlyIdempotent
Inspect

List Salesforce metadata elements of a specific type, such as flows, custom objects, or reports, optionally scoped by folder

ParametersJSON Schema
NameRequiredDescriptionDefault
typeYesThe metadata type
folderNoThe folder name (optional). If not provided, all folders are searched.
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
pageSizeNo(optional) Maximum number of records to return per page when the response requires pagination. If omitted, page size is calculated automatically.
metadata_read
Read-onlyIdempotent
Inspect

Read full details for one or more Salesforce metadata elements of a specified type, such as flows, validation rules, or approval processes

ParametersJSON Schema
NameRequiredDescriptionDefault
typeYesThe metadata type
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
pageSizeNo(optional) Maximum number of records to return per page when the response requires pagination. If omitted, page size is calculated automatically.
fullNamesYesThe full name(s) of the metadata elements to read.
metadata_update
Idempotent
Inspect

Update one or more Salesforce metadata elements of a specified type, such as flows, validation rules, or custom labels

ParametersJSON Schema
NameRequiredDescriptionDefault
typeYesThe metadata type.
upsertNoWhether to upsert the metadata. If true, the metadata will be upserted (created if it does not yet exist). If false, the metadata will be updated.
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
metadataYesThe array of metadata records to update. Each record must include at least a 'fullName' property and other required fields for the type. See instructions for details.
page_layout_cloneInspect

Create a new page layout by cloning an existing layout in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
layoutYesThe name or ID of the existing layout to clone. ID is preferred if you have it. If using a name, you must also provide the sObject
sObjectYesThe name of the sObject to which the layout applies. Not needed if you have provided the layout ID
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
namespaceYesThe namespace prefix of the existing layout to clone. Not needed if you have provided the layout ID or if the layout has no namespace
newLayoutNameYesName of the new (cloned) page layout to create
page_layout_update
Idempotent
Inspect

Update the properties or contents of a Salesforce page layout, including adding, removing, or reordering fields, sections, and related lists

ParametersJSON Schema
NameRequiredDescriptionDefault
patchYesThe array of modifications that need to be applied. This should be provided in the `JSON Patch` format
layoutYesThe name or ID of the layout. ID is preferred if you have it. If using a name, you must also provide the sObject
sObjectNoThe name of the sObject to which the layout applies. Not needed if you have provided the layout ID
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
namespaceNoThe namespace prefix of the Page Layout. Not needed if you have provided the layout ID or if the layout has no namespace
permission_set_assignmentsC
Destructive
Inspect

Assign or remove permission sets from users in Salesforce.

ParametersJSON Schema
NameRequiredDescriptionDefault
usersYesThe names, usernames or IDs of the users
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
operationYesThe operation to perform: 'add' to assign permission sets to users, 'remove' to remove assignments from users
permissionSetsYesThe names, labels or IDs of the permission sets
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

While annotations declare destructiveHint=true and idempotentHint=false, the description fails to disclose what specifically is destroyed (PermissionSetAssignment records) or explain the non-idempotent behavior (e.g., whether adding an existing assignment fails silently or errors). It adds no context about batch limits or Salesforce-specific side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single 9-word sentence is front-loaded and contains no filler, earning high marks for structural efficiency. However, the extreme brevity borders on under-specification for a destructive operation with multiple array parameters.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the destructive nature, 4 parameters, array inputs implying batch operations, and no output schema, the description is insufficient. It omits expected behavior on partial failures, returns values, and the irreversible nature of removing assignments.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the baseline score is 3. The description does not augment the schema's parameter documentation (e.g., elaborating on valid identifier formats for 'users' or 'permissionSets' beyond what the schema property descriptions already provide).

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses specific verbs ('Assign' and 'remove') and clearly identifies the resource ('permission sets') and scope ('from users in Salesforce'). It implicitly distinguishes from sibling 'permission_set_update' by focusing on user assignments rather than metadata updates, though it does not explicitly contrast with other user management tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to prefer this tool over alternatives like 'user_update' or 'permission_set_update', nor does it mention prerequisites (e.g., admin privileges) or advise on choosing between 'add' and 'remove' operations beyond the literal words.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

permission_set_update
Idempotent
Inspect

Update the properties or contents of a permission set in Salesforce, including read and edit access to objects and fields

ParametersJSON Schema
NameRequiredDescriptionDefault
patchYesThe array of modifications that need to be applied. This should be provided in the `JSON Patch` format
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
namespaceNoThe namespace of the permission set, if applicable
permissionSetYesThe name or ID of the permission set.
profile_cloneInspect

Clone an existing user profile in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
profileYesThe name of the new Profile
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
clonedProfileNameYesThe name of existing Profile which will be cloned
profile_describe
Read-onlyIdempotent
Inspect

Return detailed metadata for a Salesforce Profile.

ParametersJSON Schema
NameRequiredDescriptionDefault
profileYesThe name or ID of the Profile.
sObjectYesUse this to return only permissions related to the a specific sObject type.
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
permissionTypesYesList of specific permission types to return. Use this whenever possible (especially for standard profiles) to reduce the size of the response.
profile_update
Idempotent
Inspect

Update a Salesforce user profile, including object permissions, field-level security, tab visibility, and system permissions

ParametersJSON Schema
NameRequiredDescriptionDefault
patchYesThe array of modifications that need to be applied. This should be provided in the `JSON Patch` format
profileYesThe name or ID of the Profile
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
record_type_createInspect

Create a new sObject record type in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
nameYesThe name of the new record type
labelYesThe label for the new record type
activeNoWhether the new record type should be active
sObjectYesThe name of the object for which the record type is being created. Include a namespace prefix for custom objects if applicable
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
descriptionYesThe description for the new record type
defaultLayoutYesThe default layout to use for all profiles. If not provided, the default layout will be the standard layout for the object
businessProcessYesThe full name or ID of the business process associated with the record type
existingRecordTypeYesThe name of the existing record type to use as a basis for the new record type. If not provided, the Master record type will be used
defaultAvailabilityYesThe default availability settings for the new record type on all profiles. If not specified, the record type will be hidden for all profiles
availabilityOverridesYesAn (optional) array of record type availabilities overrides for one or more profiles
compactLayoutAssignmentYesThe compact layout that is assigned to the record type.
layoutAssignmentOverridesYesAn (optional) array of page layout assignments overrides for one or more profiles
record_type_update
Idempotent
Inspect

Update or activate/deactivate an sObject record type in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
labelYesThe new human readable label
activeYesUse this property to activate or deactivate a record type
newNameYesThe new API name
sObjectYesThe name of the object
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
recordTypeYesThe name or ID of the record type to update
descriptionYesThe updated description of the record type
defaultLayoutYesThe default layout to use for all profiles. If not provided, the default layout will be the standard layout for the object
businessProcessYesThe name of the business process associated with the record type
defaultAvailabilityYesThe default availability settings for the new record type
availabilityOverridesYesAn (optional) array of record type availabilities overrides for one or more profiles
compactLayoutAssignmentYesThe compact layout that is assigned to the record type.
layoutAssignmentOverridesYesAn (optional) array of page layout assignments overrides for one or more profiles
report_run
Read-onlyIdempotent
Inspect

Execute a Salesforce report by ID and return its results, with optional filters and format overrides

ParametersJSON Schema
NameRequiredDescriptionDefault
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
pageSizeNo(optional) Maximum number of records to return per page when the response requires pagination. If omitted, page size is calculated automatically.
reportIdYesThe ID of the report to execute (15 or 18 character Salesforce ID)
maxRecordsYesMaximum number of records to return. Defaults to 2000
includeDetailsYesWhether to include detailed row data in the response. Defaults to true
reportMetadataYesOptional report metadata to override report configuration
sf_connection_manage
Destructive
Inspect

Manage connections to Salesforce orgs associated with the user's Cirra AI account. Call cirra_ai_init at least once before using this tool.

ParametersJSON Schema
NameRequiredDescriptionDefault
actionYesThe action to perform. Options: 'list' (list all connections), 'describe' (provide details of the connection), 'add' (add a new connection), 'reauthenticate' (refresh auth for a connection), 'remove' (remove a connection)
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
sobject_createInspect

Create a new custom object (sObject) in Salesforce with specified sharing model, deployment status, and configuration options

ParametersJSON Schema
NameRequiredDescriptionDefault
labelYesThe human readable label for the field. If it is not provided, use the sObject property after stripping any suffix, replacing underscores with spaces and capitalizing the elements
sObjectYesThe name of the object. For example, Account.
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
descriptionYesProvides a description of the object's purpose. Generate a value for this if it is not provided
pluralLabelYesThe plural version of the human readable label for the field
enableSearchNoWhether to enable search for the object. Default is false
sharingModelYesCommon options are `ReadWrite`, `Read` and `Private`
enableHistoryNoWhether to enable field history tracking for the object
enableReportsNoWhether to enable reports for the object
nameFieldTypeYesThe type of the name field. Options are `AutoNumber` or `Text` (the default)
nameFieldLabelNoThe label for the name field. Defaults to `<obj label> Name`
deploymentStatusYesOptions are `Deployed` (the default) and `In Development`
enableActivitiesNoWhether to enable activities for the object
allowInChatterGroupsNoWhether to allow the object to be used in Chatter groups
nameFieldDisplayFormatNoFor `AutoNumber` name fields only: the format to use for the display of the auto-number. For example, `A-{0000}`
nameFieldStartingNumberNoFor `AutoNumber` name fields only: the starting number for the auto-number. For example, `1000`
sobject_describe
Read-onlyIdempotent
Inspect

Return basic metadata properties for the specified sObject, as well as a list of fields, relationships and record types.

ParametersJSON Schema
NameRequiredDescriptionDefault
sObjectYesThe API name, label or ID of the sObject
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
sobject_dml
Destructive
Inspect

Create, update, delete, or upsert Salesforce sObject records via DML operations

ParametersJSON Schema
NameRequiredDescriptionDefault
recordsNoArray of records to process. For an 'update' operation the records must include an `Id` property`. For 'create' or 'upsert' the records may **not** have an `Id`. Do not use this property for the 'delete' operation
sObjectYesAPI name of the sObject
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
operationYesType of DML operation to perform. Always ask for explicit user permission before executing any of these operations
recordIdsNoOnly used for the 'delete' operation: the IDs of the record to deletes
dmlOptionsNoOptional DML options to use for the operation
externalIdFieldNoExternal ID field name. Required for upsert operations, ignored in other cases
sobject_field_createInspect

Create a new custom field for an sObject in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
labelYesThe label for the field
sObjectYesThe API name, label or ID of the sObject
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
fieldNameYesThe API name of the new field. For example, NewField__c
fieldTypeYesThe type of the field
defaultFLSNoThe default Field-Level Security (FLS) setting to apply for all profiles for the new field
propertiesNoA map of properties used when creating the field. Some may be required, depending on the field type. See instructions for details
descriptionYesThe description for the field
flsOverridesNoAn (optional) array of Field-Level Security (FLS) overrides for one or more profiles
inlineHelpTextYesThe inline help text for the field
sobject_field_update
Idempotent
Inspect

Update properties of a custom sObject field (standard or custom) in Salesforce, including local picklist values

ParametersJSON Schema
NameRequiredDescriptionDefault
sObjectYesThe API name, label or ID of the sObject
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
fieldNameYesThe API name, label or ID of the field. For example Industry, Segment__c, SomeNamespace__SomeField__c, 'Some Field' or 00NEk00000B8BYE.
flsUpdatesNoAn (optional) array of Field-Level Security (FLS) settings to update for one or more profiles
propertiesYesProperties to update. Some are required, depending on the field type. See instructions for details
sobjects_list
Read-onlyIdempotent
Inspect

Lists all the available sObject types with their API names and labels. To get more details about an sObject, use sobject_describe

ParametersJSON Schema
NameRequiredDescriptionDefault
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
pageSizeNo(optional) Maximum number of records to return per page when the response requires pagination. If omitted, page size is calculated automatically.
customObjectsOnlyYesif true, list only custom objects
sobject_update
Idempotent
Inspect

Update properties of a custom Salesforce object, such as label, plural label, description, sharing model, or deployment status

ParametersJSON Schema
NameRequiredDescriptionDefault
sObjectYesThe API name, label or ID of the custom sObject
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
propertiesYesA map of properties to update on the object. For example: 'label'. At least one property must be updated
soql_query
Read-onlyIdempotent
Inspect

Run a Salesforce SOQL query to return a list of sObject records, with automatic masking of encrypted fields

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNoThe maximum number of records to return. The default is 200. Note: LIMIT is automatically omitted for aggregate queries without GROUP BY.
fieldsYesList of fields to retrieve. May include relationship fields and aggregates
groupByNoGROUP BY clause for aggregate queries. Required when using aggregate functions with grouping, optional otherwise
orderByNo(optional) ORDER BY clause. May include fields from related objects
sObjectYesThe name of the Salesforce object to query
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
pageSizeNo(optional) Maximum number of records to return per page when the response requires pagination. If omitted, page size is calculated automatically.
whereClauseYesWHERE clause. May include conditions on related objects. Do NOT include APEX snippets or variables: use only literal values
havingClauseNoHAVING clause to filter grouped results by aggregate conditions (e.g. 'COUNT(Id) > 5'). Requires groupBy to be set
tooling_api_describe
Read-onlyIdempotent
Inspect

List all objects available through the Salesforce Tooling API and their properties. Use tooling_api_query with FieldDefinition to get field details

ParametersJSON Schema
NameRequiredDescriptionDefault
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
verboseYesIf false or missing, return only the names of the objects. This is the default. If true, return additional properties for each object.
pageSizeNo(optional) Maximum number of records to return per page when the response requires pagination. If omitted, page size is calculated automatically.
tooling_api_dml
Destructive
Inspect

Create, update, delete, or upsert Salesforce Tooling API records, such as Apex classes, triggers, and custom metadata

ParametersJSON Schema
NameRequiredDescriptionDefault
recordNoThe record to process, with all relevant fields. For an 'update' operation the record object must include an `Id` property`. For 'create' or 'upsert' the record may **not** have an `Id`. Do not use this property for the 'delete' operation
sObjectYesAPI name of the Tooling API object
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
recordIdNoOnly used for the 'delete' operation: the ID of the record to delete
operationYesType of DML operation to perform. Always ask for explicit user approval before executing any of these operations, and do not proceed without it
externalIdFieldNoExternal ID field name. Required for upsert operations, ignored in other cases
tooling_api_query
Read-onlyIdempotent
Inspect

Run a SOQL query against the Salesforce Tooling API to retrieve metadata objects like Apex classes, triggers, custom fields, and field definitions

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNoThe maximum number of records to return. The default is 200. Note: LIMIT is automatically omitted for aggregate queries without GROUP BY.
fieldsYesList of fields to retrieve. May include relationship fields and aggregates
groupByNoGROUP BY clause for aggregate queries. Required when using aggregate functions with grouping, optional otherwise
orderByNo(optional) ORDER BY clause
sObjectYesThe name of the Tooling API object to query
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
pageSizeNo(optional) Maximum number of records to return per page when the response requires pagination. If omitted, page size is calculated automatically.
whereClauseYesWHERE clause. May include conditions on related objects
user_createInspect

Create a new Salesforce user. You can clone an existing user by providing the template parameter, or create a new user from scratch by providing the profile and other parameters

ParametersJSON Schema
NameRequiredDescriptionDefault
emailYesThe email of the user
profileNoThe name or ID of the profile to use for the new user. Not required if template is provided
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
lastNameYesThe last name of the user
templateNoThe name, username, email or id of an existing user to use a a template for the new user
usernameYesThe username of the user. Must be globally unique across all Salesforce organizations
firstNameYesThe first name of the user
propertiesNoAn optional map of additional properties to set on the new user
user_describe
Read-onlyIdempotent
Inspect

Return complete metadata for a Salesforce user

ParametersJSON Schema
NameRequiredDescriptionDefault
userYesThe name, username, email or ID of the user
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
user_update
Idempotent
Inspect

Update a Salesforce user, including activating, deactivating, freezing, unfreezing, resetting passwords, or modifying user properties

ParametersJSON Schema
NameRequiredDescriptionDefault
userYesThe id, username, full name or email of the user to update
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
operationYesThe type of operation to perform. Can be one of: - `deactivate`: To deactivate a user - `activate`: To activate a user - `reset_password`: To reset password of a user. An email to reset password will be sent to the user's email - `freeze`: To freeze a user - `unfreeze`: To unfreeze a user - `unlock_password`: To unlock password for a user - `update`
propertiesNoThe properties to update when choosing the `update` operation
value_set_createInspect

Create a new global value set in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
nameYesThe name of the value set
sortedNoSet to true if the values should be sorted
valuesYesThe values for the value set
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
namespaceNoThe namespace, if applicable
descriptionNoThe description (optional). Max 255 characters
masterLabelNoThe label (optional). Will default to the name if not specified
value_set_update
Idempotent
Inspect

Update the values in a standard or global value set in Salesforce

ParametersJSON Schema
NameRequiredDescriptionDefault
nameYesThe name or ID of the value set
typeNoIndicate whether this is a global or standard value set. Not needed if the ID of the value set is provided
valuesYesThe values for the value set
sf_userNo(optional) Salesforce username to identify the connection to use. Omit this to use the current default connection.
namespaceNoThe namespace for a global value set, if applicable

Discussions

No comments yet. Be the first to start the discussion!

Try in Browser

Your Connectors

Sign in to create a connector for this server.

Resources