Skip to main content
Glama

Update a portal

update_portal
Destructive

Update a portal. Update a help center portal: its name, slug, header, colour, custom domain or locales. Requires feature: help_center.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "portal_slug": "<portal_slug>"
    },
    "name": "update_portal"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoName for the portal
slugNoSlug for the portal to display in link
colorNoHeader color for help-center
configNoConfiguration about supporting locales
archivedNoStatus to check if portal is live
page_titleNoPage title for the portal
header_textNoHelp center header
portal_slugYesThe slug of the portal, as it appears in its help center link
custom_domainNoCustom domain to display help center.
homepage_linkNolink to main dashboard

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=false, so the safety profile is covered. Beyond that, the description adds only the feature-flag requirement and says nothing about partial-update behavior (whether omitted fields are preserved or reset), what exactly a destructive update can overwrite, or how the nested config object is treated.

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 definition is short and front-loaded, with the field list immediately after the purpose. The opening 'Update a portal. Update a help center portal' is mildly redundant, but the feature note is clearly delimited.

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?

This is a destructive, ten-parameter mutation tool with a nested object and no output schema, so the description carries significant weight. It omits partial-update semantics, treatment of the nested config object, and any warning about irreversible changes, leaving key questions an agent would need answered before calling it.

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 coverage is 100%, so the schema already describes all ten parameters including portal_slug as the identifier and config as locale configuration. The description lists several updatable fields but adds no meaning beyond the schema, such as clarifying that portal_slug selects the target while the rest are optional replacement values. Baseline 3 is appropriate.

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 states a specific verb and resource and enumerates the mutable fields (name, slug, header, colour, custom domain, locales), so an agent knows exactly what the tool changes. It does not explicitly distinguish itself from add_new_portal_to_account or delete_portal, but the 'update' verb makes the distinction largely self-evident.

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 only guidance is the feature prerequisite 'Requires feature: help_center'. There is no indication of when to use this versus creating a new portal or deleting one, and no mention of prerequisites like admin permissions or whether the portal must already exist.

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