Skip to main content
Glama

Cirra AI Salesforce Admin MCP Server

page_layout_update

Destructive

Update or rename a page layout in Salesforce. Supports modifying layout contents via JSON Patch, renaming a layout, or both in a single call

Input Schema

NameRequiredDescriptionDefault
patchNoThe array of modifications that need to be applied. This should be provided in the `JSON Patch` format. At least one of patch or newLayoutName must be provided
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
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'.
newLayoutNameNoThe new name for the layout. When provided, the layout will be renamed (via clone and delete). Can be combined with patch to rename and update in a single call
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 metadata payload that was actually sent to Salesforce for this operation (post-normalization/defaulting), so you can verify it matches what was intended without a separate read.
artifactCategoryNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • 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"
      +}
    • removedInput schema / properties / patch / items / properties
      Removed value: -{
      -  "from": {
      -    "description": "For move and copy operations only: a JSON Pointer path specifying the source",
      -    "type": "string"
      -  },
      -  "op": {
      -    "description": "The operation to perform",
      -    "enum": [
      -      "add",
      -      "remove",
      -      "replace",
      -      "move",
      -      "copy",
      -      "test"
      -    ],
      -    "type": "string"
      -  },
      -  "path": {
      -    "description": "A JSON Pointer path specifying where the change should be applied",
      -    "type": "string"
      -  },
      -  "value": {
      -    "description": "The value to add, replace, or test. Not required for move and copy operations"
      -  }
      -}
    • removedInput schema / properties / patch / items / required
      Removed value: -[
      -  "op",
      -  "path",
      -  "value"
      -]
    • removedInput schema / properties / patch / items / type
      Removed value: -"object"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": true,
      +  "properties": {
      +    "appliedMetadata": {
      +      "additionalProperties": true,
      +      "description": "The metadata payload that was actually sent to Salesforce for this operation (post-normalization/defaulting), so you can verify it matches what was intended without a separate read.",
      +      "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. Changed3 schema fields changed
    • addedInput schema / properties / newLayoutName
      Added value: +{
      +  "description": "The new name for the layout. When provided, the layout will be renamed (via clone and delete). Can be combined with patch to rename and update in a single call",
      +  "type": "string"
      +}
    • changedInput schema / properties / patch / description
      Previous value: -"The array of modifications that need to be applied. This should be provided in the `JSON Patch` format"New value: +"The array of modifications that need to be applied. This should be provided in the `JSON Patch` format. At least one of patch or newLayoutName must be provided"
    • changedInput schema / required
      Previous value: -[
      -  "layout",
      -  "patch"
      -]New value: +[
      +  "layout"
      +]
  6. Added
  7. Removed
  8. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true; the description adds genuinely new context by revealing that rename is implemented 'via clone and delete', which explains the destructive flag and warns that the layout gets replaced. It says nothing about required permissions or side effects on dependent record types, but with annotations covering the safety profile this is a solid contribution.

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?

Two tight sentences, no filler, with the core verb and resource front-loaded in the first clause and the mode options immediately following. Every sentence earns its place.

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?

An output schema exists and annotations carry the behavioral profile, so the description does not need to explain return values or safety. It covers the two mutation paths adequately; only cross-tool routing and prerequisites for name-based lookup are left implicit elsewhere.

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 including the context_handle/cirra_ai_team connection selectors is already documented in the schema. The description's 'patch, newLayoutName, or both' restates the schema constraint rather than adding syntax or format detail, so the 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 or rename a page layout in Salesforce') and enumerates the two supported mutation modes. It does not explicitly differentiate from close siblings such as page_layout_clone or metadata_update, so an agent still has to infer which tool applies.

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 listing the two modes (JSON Patch content edit, rename, or both), but gives no when-to-use/when-not guidance and never points to alternatives like page_layout_clone for duplicating a layout or metadata_update for other metadata. Usage must be inferred from mode capability alone.

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