Server Details
Comprehensive Salesforce administration and data management capabilities
- Status
- Healthy
- Last Tested
- Transport
- Streamable HTTP
- URL
Available Tools
47 toolscirra_ai_initTry in Inspector
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
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | (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_user | No | (optional) A Salesforce username identifying the Salesforce connection to use. Omit this to use the current default connection. | |
| cirra_ai_team | No | (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). |
group_createTry in Inspector
Create a new public group, queue or role in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name for the group | |
| type | Yes | The type of group to create | |
| label | No | The label for the group. Will be generated from the name if not provided. | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| properties | No | Additional properties for the group | |
| description | Yes | The description for the group | |
| supportedObjects | No | The objects that the queue can access |
group_members_addTry in Inspector
Add users to one or more public groups or queues in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| users | Yes | The names, usernames or IDs of the users who we want to add to the groups | |
| groups | Yes | The names or IDs of the groups or queues to add the users to | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. |
group_members_listTry in Inspector
Get group memberships for public groups, queues or roles and/or specified users. Both groups and users are optional, but at least one must be provided.
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| users | No | The names, usernames or IDs of the users for whom we want to find the groups | |
| groups | No | The names, labels or IDs of the public groups, queues or roles for which we want to find the members | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| recursive | No | Whether to recursively explore sub-groups to find members. Defaults to false |
group_members_removeTry in Inspector
Remove users from one or more public groups or queues in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| users | Yes | The names, usernames or IDs of the users who we want to remove from the groups | |
| groups | Yes | The names or IDs of the groups or queues to remove the users from | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. |
group_updateTry in Inspector
Update a public group or queue in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| group | Yes | The name or ID of the public group or queue. | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| properties | Yes | Properties to update |
link_buildTry in Inspector
Build Salesforce links for setup pages. Always use this tool when user requests a setup page link
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | The type of the link to build | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. If not provided, the default connection will be used | |
| setupConfig | No | Used with `setup` types. Describes the type of setup page to build link for |
logoutTry in Inspector
Logout from Cirra AI MCP server
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
metadata_createTry in Inspector
Create one or more Salesforce metadata elements of a specified type
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | The metadata type. | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| metadata | Yes | The array of metadata records to create. Each record must include at least a 'fullName' property |
metadata_deleteTry in Inspector
Delete one or more metadata elements of a specified type in Salesforce. Maximum number is 10 per batch - DO NOT EXCEED.
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | The metadata type. | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| fullNames | Yes | The full name(s) of the metadata element(s) to delete. |
metadata_describeTry in Inspector
Return a list of all the Salesforce metadata types available in the org, along with a few global properties of the org
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| verbose | Yes | If false or missing, return only the names of the metadata types. This is the default. If true, return additional properties for each type. |
metadata_listTry in Inspector
List Salesforce metadata elements of a specific type, optionally scoped by folder
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | The metadata type | |
| folder | Yes | The folder name (optional). If not provided, all folders are searched. | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. |
metadata_readTry in Inspector
Provide full details for one or more metadata elements of a specified type
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | The metadata type | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| fullNames | Yes | The full name(s) of the metadata elements to read. |
metadata_updateTry in Inspector
Update one or more Salesforce metadata elements of a specified type.
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | The metadata type. | |
| upsert | No | Whether 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_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| metadata | Yes | The 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_cloneTry in Inspector
Create a new page layout by cloning an existing layout in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| layout | Yes | The 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 | |
| sObject | Yes | The name of the sObject to which the layout applies. Not needed if you have provided the layout ID | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| namespace | Yes | The namespace prefix of the existing layout to clone. Not needed if you have provided the layout ID or if the layout has no namespace | |
| newLayoutName | Yes | Name of the new (cloned) page layout to create |
page_layout_createTry in Inspector
Create a new page layout from scratch in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sObject | Yes | The name of the object to which the layout applies. Include a namespace prefix for custom objects if applicable | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| layoutName | Yes | The name of the new layout | |
| layoutSections | Yes | An JSON serialised array of Metadata.LayoutSection which MUST include the required fields for the object |
page_layout_updateTry in Inspector
update the properties or contents of a page layout, include adding or removing fields in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| patch | Yes | The array of modifications that need to be applied. This should be provided in the `JSON Patch` format | |
| layout | Yes | The name or ID of the layout. ID is preferred if you have it. If using a name, you must also provide the sObject | |
| sObject | No | The name of the sObject to which the layout applies. Not needed if you have provided the layout ID | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| namespace | No | The namespace prefix of the Page Layout. Not needed if you have provided the layout ID or if the layout has no namespace |
permission_set_assignments_addTry in Inspector
Add permission set assignments to users in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| users | Yes | The names, usernames or IDs of the users who we want to assign the permission sets to | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| permissionSets | Yes | The names, labels or IDs of the permission sets that we want to assign |
permission_set_assignments_listTry in Inspector
Get permission set assignments for the specified user(s) and/or permission set(s)
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| users | Yes | The names, usernames or IDs of the users for whom we want to find the assignments | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| permissionSets | Yes | The names, labels or IDs of the permission sets for which we want to find the assignments |
permission_set_assignments_removeTry in Inspector
Remove permission set assignments from users in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| users | Yes | The names, usernames or IDs of the users from whom we want to remove the assignments | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| permissionSets | Yes | The names, labels or IDs of the permission sets that we want to remove assignments for |
permission_set_createTry in Inspector
Create a new permission set in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the permission set. | |
| label | Yes | The label of the permission set. | |
| license | Yes | The permission set license or the user license associated with this permission set. | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| description | Yes | The description of the permission set. | |
| hasActivationRequired | Yes | Whether the permission set requires activation. |
permission_set_updateTry in Inspector
Update the properties or contents of a permission set in Salesforce, including read and edit access to objects and fields
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| patch | Yes | The array of modifications that need to be applied. This should be provided in the `JSON Patch` format | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| namespace | No | The namespace of the permission set, if applicable | |
| permissionSet | Yes | The name or ID of the permission set. |
profile_cloneTry in Inspector
Clone an existing user profile in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| profile | Yes | The name of the new Profile | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| clonedProfileName | Yes | The name of existing Profile which will be cloned |
profile_createTry in Inspector
Create a new Salesforce profile from a JSON object
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| profile | Yes | The name of the Profile | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| profileJson | Yes | A JSON serialised array of a Metadata.Profile object, including only the relevant elements | |
| userLicenseName | Yes | Licence type for the profile. For example, Salesforce |
profile_describeTry in Inspector
Return detailed metadata for a Salesforce Profile.
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| profile | Yes | The name or ID of the Profile. | |
| sObject | Yes | Use this to return only permissions related to the a specific sObject type. | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| permissionTypes | Yes | List of specific permission types to return. Use this whenever possible (especially for standard profiles) to reduce the size of the response. |
profile_updateTry in Inspector
Update a user profile in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| patch | Yes | The array of modifications that need to be applied. This should be provided in the `JSON Patch` format | |
| profile | Yes | The name or ID of the Profile | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. |
record_type_createTry in Inspector
Create a new sObject record type in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the new record type | |
| label | Yes | The label for the new record type | |
| active | No | Whether the new record type should be active | |
| sObject | Yes | The name of the object for which the record type is being created. Include a namespace prefix for custom objects if applicable | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| description | Yes | The description for the new record type | |
| defaultLayout | Yes | The default layout to use for all profiles. If not provided, the default layout will be the standard layout for the object | |
| businessProcess | Yes | The full name or ID of the business process associated with the record type | |
| existingRecordType | Yes | The 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 | |
| defaultAvailability | Yes | The default availability settings for the new record type on all profiles. If not specified, the record type will be hidden for all profiles | |
| availabilityOverrides | Yes | An (optional) array of record type availabilities overrides for one or more profiles | |
| compactLayoutAssignment | Yes | The compact layout that is assigned to the record type. | |
| layoutAssignmentOverrides | Yes | An (optional) array of page layout assignments overrides for one or more profiles |
record_type_updateTry in Inspector
Update or activate/deactivate an sObject record type in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | Yes | The new human readable label | |
| active | Yes | Use this property to activate or deactivate a record type | |
| newName | Yes | The new API name | |
| sObject | Yes | The name of the object | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| recordType | Yes | The name or ID of the record type to update | |
| description | Yes | The updated description of the record type | |
| defaultLayout | Yes | The default layout to use for all profiles. If not provided, the default layout will be the standard layout for the object | |
| businessProcess | Yes | The name of the business process associated with the record type | |
| defaultAvailability | Yes | The default availability settings for the new record type | |
| availabilityOverrides | Yes | An (optional) array of record type availabilities overrides for one or more profiles | |
| compactLayoutAssignment | Yes | The compact layout that is assigned to the record type. | |
| layoutAssignmentOverrides | Yes | An (optional) array of page layout assignments overrides for one or more profiles |
report_runTry in Inspector
Execute a Salesforce report and return its results
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| reportId | Yes | The ID of the report to execute (15 or 18 character Salesforce ID) | |
| maxRecords | Yes | Maximum number of records to return. Defaults to 2000 | |
| includeDetails | Yes | Whether to include detailed row data in the response. Defaults to true | |
| reportMetadata | Yes | Optional report metadata to override report configuration |
sf_connection_manageTry in Inspector
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
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | The 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_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. |
sobject_createTry in Inspector
Create a new custom Salesforce object in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | Yes | The 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 | |
| sObject | Yes | The name of the object. For example, Account. | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| description | Yes | Provides a description of the object's purpose. Generate a value for this if it is not provided | |
| pluralLabel | Yes | The plural version of the human readable label for the field | |
| enableSearch | No | Whether to enable search for the object. Default is false | |
| sharingModel | Yes | Common options are `ReadWrite`, `Read` and `Private` | |
| enableHistory | No | Whether to enable field history tracking for the object | |
| enableReports | No | Whether to enable reports for the object | |
| nameFieldType | Yes | The type of the name field. Options are `AutoNumber` or `Text` (the default) | |
| nameFieldLabel | No | The label for the name field. Defaults to `<obj label> Name` | |
| deploymentStatus | Yes | Options are `Deployed` (the default) and `In Development` | |
| enableActivities | No | Whether to enable activities for the object | |
| allowInChatterGroups | No | Whether to allow the object to be used in Chatter groups | |
| nameFieldDisplayFormat | No | For `AutoNumber` name fields only: the format to use for the display of the auto-number. For example, `A-{0000}` | |
| nameFieldStartingNumber | No | For `AutoNumber` name fields only: the starting number for the auto-number. For example, `1000` |
sobject_describeTry in Inspector
Return basic metadata properties for the specified sObject, as well as a list of fields, relationships and record types.
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sObject | Yes | The API name, label or ID of the sObject | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. |
sobject_dmlTry in Inspector
Perform DML operations on Salesforce records. This function is used to create, update, delete, and upsert records in Salesforce.
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| records | No | Array 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 | |
| sObject | Yes | API name of the sObject | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| operation | Yes | Type of DML operation to perform. Always ask for explicit user permission before executing any of these operations | |
| recordIds | No | Only used for the 'delete' operation: the IDs of the record to deletes | |
| dmlOptions | No | Optional DML options to use for the operation | |
| externalIdField | No | External ID field name. Required for upsert operations, ignored in other cases |
sobject_field_createTry in Inspector
Create a new custom field for an sObject in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | Yes | The label for the field | |
| sObject | Yes | The API name, label or ID of the sObject | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| fieldName | Yes | The API name of the new field. For example, NewField__c | |
| fieldType | Yes | The type of the field | |
| defaultFLS | No | The default Field-Level Security (FLS) setting to apply for all profiles for the new field | |
| properties | No | A map of properties used when creating the field. Some may be required, depending on the field type. See instructions for details | |
| description | Yes | The description for the field | |
| flsOverrides | No | An (optional) array of Field-Level Security (FLS) overrides for one or more profiles | |
| inlineHelpText | Yes | The inline help text for the field |
sobject_field_updateTry in Inspector
Update properties of a custom sObject field (standard or custom) in Salesforce, including local picklist values
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sObject | Yes | The API name, label or ID of the sObject | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| fieldName | Yes | The API name, label or ID of the field. For example Industry, Segment__c, SomeNamespace__SomeField__c, 'Some Field' or 00NEk00000B8BYE. | |
| flsUpdates | No | An (optional) array of Field-Level Security (FLS) settings to update for one or more profiles | |
| properties | Yes | Properties to update. Some are required, depending on the field type. See instructions for details |
sobjects_listTry in Inspector
Lists all the available sObject types and provides some of their key properties including ID, name, label and type. To get more details about an sObject, use sobject_describe
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| customObjectsOnly | Yes | if true, list only custom objects |
sobject_updateTry in Inspector
Update properties of a custom object in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sObject | Yes | The API name, label or ID of the custom sObject | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| properties | Yes | A map of properties to update on the object. For example: 'label'. At least one property must be updated |
soql_queryTry in Inspector
Runs a Salesforce SOQL query to return a list of sObject records. Encrypted fields are masked in the response
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of records to return. The default is 100. Note: LIMIT is automatically omitted for aggregate queries without GROUP BY. | |
| fields | Yes | List of fields to retrieve. May include relationship fields and aggregates | |
| groupBy | Yes | GROUP BY clause for aggregate queries. Required when using aggregate functions with grouping. Example: 'StageName' or 'AccountId, StageName' | |
| orderBy | Yes | ORDER BY clause. May include fields from related objects | |
| sObject | Yes | The name of the Salesforce object to query | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| whereClause | Yes | WHERE clause. May include conditions on related objects. Do NOT include APEX snippets or variables: use only literal values |
tooling_api_describeTry in Inspector
Return a list of all the objects available through the Salesforce Tooling API. Use tooling_api_query with FieldDefinition to get the available fields for an object.
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| verbose | Yes | If false or missing, return only the names of the objects. This is the default. If true, return additional properties for each object. |
tooling_api_dmlTry in Inspector
Perform DML operations on Salesforce Tooling API records. This function is used to create, update, delete, and upsert tooling API records in Salesforce.
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| record | No | The 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 | |
| sObject | Yes | API name of the Tooling API object | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| recordId | No | Only used for the 'delete' operation: the ID of the record to delete | |
| operation | Yes | Type of DML operation to perform. Always ask for explicit user approval before executing any of these operations, and do not proceed without it | |
| externalIdField | No | External ID field name. Required for upsert operations, ignored in other cases |
tooling_api_queryTry in Inspector
Runs a Salesforce Tooling API query to return a list of metadata objects
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of records to return. The default is 100. Note: LIMIT is automatically omitted for aggregate queries without GROUP BY. | |
| fields | Yes | List of fields to retrieve. May include relationship fields and aggregates | |
| groupBy | Yes | GROUP BY clause for aggregate queries. Required when using aggregate functions with grouping. Example: 'NamespacePrefix' or 'NamespacePrefix, TableEnumOrId' | |
| orderBy | Yes | ORDER BY clause | |
| sObject | Yes | The name of the Tooling API object to query | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| whereClause | Yes | WHERE clause. May include conditions on related objects |
tooling_api_searchTry in Inspector
Runs a Tooling API search to return a list of matching metadata objects in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The SOSL query to execute against the Tooling API. Please take into account all available documentation on object types, field names and limitations for the Tooling API SOSL queries | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. |
user_createTry in Inspector
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
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | The email of the user | ||
| profile | No | The name or ID of the profile to use for the new user. Not required if template is provided | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| lastName | Yes | The last name of the user | |
| template | No | The name, username, email or id of an existing user to use a a template for the new user | |
| username | Yes | The username of the user. Must be globally unique across all Salesforce organizations | |
| firstName | Yes | The first name of the user | |
| properties | No | An optional map of additional properties to set on the new user |
user_describeTry in Inspector
Return complete metadata for a Salesforce user
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | The name, username, email or ID of the user | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. |
user_updateTry in Inspector
Perform an update operation on a Salesforce user
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user | Yes | The id, username, full name or email of the user to update | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| operation | Yes | The 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` | |
| properties | No | The properties to update when choosing the `update` operation |
value_set_createTry in Inspector
Create a new global value set in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name of the value set | |
| sorted | No | Set to true if the values should be sorted | |
| values | Yes | The values for the value set | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| namespace | No | The namespace, if applicable | |
| description | No | The description (optional). Max 255 characters | |
| masterLabel | No | The label (optional). Will default to the name if not specified |
value_set_updateTry in Inspector
Update the values in a standard or global value set in Salesforce
ParametersJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The name or ID of the value set | |
| type | Yes | Indicate whether this is a global or standard value set. Not needed if the ID of the value set is provided | |
| values | Yes | The values for the value set | |
| sf_user | No | (optional) Salesforce username to identify the connection to use. Omit this to use the current default connection. | |
| namespace | Yes | The namespace for a global value set, if applicable |
FAQ
How do I claim this server?
To claim this server, publish a /.well-known/glama.json file on your server's domain with the following structure:
{
"$schema": "https://glama.ai/mcp/schemas/connector.json",
"maintainers": [
{
"email": "your-email@example.com"
}
]
}
The email address must match the email associated with your Glama account. Once verified, the server will appear as claimed by you.
What are the benefits of claiming a server?
- Control your server's listing on Glama, including description and metadata
- Receive usage reports showing how your server is being used
- Get monitoring and health status updates for your server