Skip to main content
Glama

Cirra AI Salesforce Admin MCP Server

sobject_field_update

Idempotent

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

Input 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. Omit a key to leave the stored value unchanged; pass null to clear an optional string (e.g. inlineHelpText, description); any other string is stored. Some properties are required depending on the field type. See instructions for details.
cirra_ai_teamNo(optional) Cirra team ID or name that owns the Salesforce connection to use for this call. Must be provided together with 'sf_user'. Use it to run against a specific team's connection without changing your default team — e.g. to keep separate chats on Salesforce orgs in different teams. Omit it when this call carries the context_handle from cirra_ai_init, which names the team for the conversation. A user with more than one place to work (several teams, or a team and a personal account) must pass either the context_handle or 'cirra_ai_team' + 'sf_user'.
context_handleNo(recommended) The conversation context handle returned by cirra_ai_init in this conversation. Pass the exact context_handle value from the most recent cirra_ai_init result so this call runs against the team and Salesforce connection selected for this conversation. A user with more than one place to work (several Cirra AI teams, or a team and a personal account) must pass either this handle or 'cirra_ai_team' + 'sf_user'; a call with neither is refused.

Output Schema

NameRequiredDescriptionDefault
messageYes
resultsNo
successYes
warningNo
errorCodeNo
errorCountNo
resultCountNo
artifactTypeNo
requestCountNo
skippedCountNo
successCountNo
appliedMetadataNoThe full resulting CustomField metadata (existing field merged with your updates), including any values the server filled in (e.g. defaulted or 'length'-alias-derived precision/scale). Use this to verify the field now matches what was intended.
artifactCategoryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / cirra_ai_team / description
      Previous value: -"(optional) Cirra team ID or name that owns the Salesforce connection to use for this call. Must be provided together with 'sf_user'. Use it to run against a specific team's connection without changing your default team — e.g. to keep separate chats on Salesforce orgs in different teams. Omit to use your current/default team."New value: +"(optional) Cirra team ID or name that owns the Salesforce connection to use for this call. Must be provided together with 'sf_user'. Use it to run against a specific team's connection without changing your default team — e.g. to keep separate chats on Salesforce orgs in different teams. Omit it when this call carries the context_handle from cirra_ai_init, which names the team for the conversation. A user with more than one place to work (several teams, or a team and a personal account) must pass either the context_handle or 'cirra_ai_team' + 'sf_user'."
    • addedInput schema / properties / context_handle
      Added value: +{
      +  "description": "(recommended) The conversation context handle returned by cirra_ai_init in this conversation. Pass the exact context_handle value from the most recent cirra_ai_init result so this call runs against the team and Salesforce connection selected for this conversation. A user with more than one place to work (several Cirra AI teams, or a team and a personal account) must pass either this handle or 'cirra_ai_team' + 'sf_user'; a call with neither is refused.",
      +  "type": "string"
      +}
    • addedInput schema / properties / flsUpdates / items / additionalProperties
      Added value: +false
    • changedInput schema / properties / properties / description
      Previous value: -"Properties to update. Some are required, depending on the field type. See instructions for details"New value: +"Properties to update. Omit a key to leave the stored value unchanged; pass null to clear an optional string (e.g. inlineHelpText, description); any other string is stored. Some properties are required depending on the field type. See instructions for details."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": true,
      +  "properties": {
      +    "appliedMetadata": {
      +      "additionalProperties": true,
      +      "description": "The full resulting CustomField metadata (existing field merged with your updates), including any values the server filled in (e.g. defaulted or 'length'-alias-derived precision/scale). Use this to verify the field now matches what was intended.",
      +      "properties": {},
      +      "type": "object"
      +    },
      +    "artifactCategory": {
      +      "type": "string"
      +    },
      +    "artifactType": {
      +      "type": "string"
      +    },
      +    "errorCode": {
      +      "type": "string"
      +    },
      +    "errorCount": {
      +      "type": "number"
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "requestCount": {
      +      "type": "number"
      +    },
      +    "resultCount": {
      +      "type": "number"
      +    },
      +    "results": {
      +      "items": {
      +        "additionalProperties": true,
      +        "properties": {},
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "skippedCount": {
      +      "type": "number"
      +    },
      +    "success": {
      +      "type": "boolean"
      +    },
      +    "successCount": {
      +      "type": "number"
      +    },
      +    "warning": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "success",
      +    "message"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / cirra_ai_team
      Added value: +{
      +  "description": "(optional) Cirra team ID or name that owns the Salesforce connection to use for this call. Must be provided together with 'sf_user'. Use it to run against a specific team's connection without changing your default team — e.g. to keep separate chats on Salesforce orgs in different teams. Omit to use your current/default team.",
      +  "type": "string"
      +}
  3. Added
  4. Removed
  5. Added
  6. Removed
  7. Changed1 schema field changed
    • changedInput schema / properties / properties / additionalProperties
      Previous value: -{}New value: +true
  8. First observed

TDQS

B3.4/5.0
Behavior3/5

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

The mention of 'local picklist values' hints at a meaningful behavioral nuance (local vs global picklists), which goes slightly beyond the annotations. However, it is never explained, and with annotations already declaring idempotentHint=true, destructiveHint=false, and openWorldHint=true, the description adds only marginal behavioral context.

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?

A single, front-loaded sentence with no filler. It is efficient, though the parenthetical interrupts the flow slightly and the sentence is short enough that it could have afforded more substance.

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?

Given an output schema exists, 100% parameter documentation, and annotations covering the safety profile, the description is complete enough for an agent to call the tool: the resource, the mutation intent, and picklist handling are all signalled.

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?

Schema description coverage is 100%, so every parameter is documented in the schema, and the freeform 'properties' object already explains omit/null/store semantics. The description adds only the picklist-values hint and no parameter-level detail beyond that, so baseline 3 applies.

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?

States a specific verb and resource: update properties of an sObject field in Salesforce. The parenthetical '(standard or custom)' clarifies scope, but the phrasing is slightly ambiguous, and nothing distinguishes this from siblings like sobject_field_create or value_set_update.

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?

No guidance on when to use this versus sobject_field_create, value_set_update, or metadata_update, and no prerequisites or exclusions are given. The agent must infer usage entirely from the name and schema.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources