Skip to main content
Glama

Change a status page component

update_status_page_component
DestructiveIdempotent

Use this when the user wants a service or group on one of their status pages renamed, described differently, moved into or out of a group, or moved up or down. Returns the component as saved and the page's components in order. Not for taking one off the page: use remove_status_page_component.

Input Schema

NameRequiredDescriptionDefault
nameNoThe new name visitors see.
groupNoThe group to move it into, by name or id; "" moves it out of its group to the top level.
orderNoIts position within its group, or the top level: 0 is first.
componentYesThe component's id or name, as get_status_page lists them.
descriptionNoThe new text under the name; "" removes it.
status_pageYesThe page's id, name or address.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true and idempotentHint=true, so the safety profile is carried structurally. The description still adds value by disclosing the return payload (the saved component plus the page's components in order), which matters since no output schema exists. It stops short of warning that clearing `description` erases text or noting permission requirements, which are covered only indirectly by the schema.

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 short clauses, front-loaded with the trigger condition, then the return value, then the exclusion. Every sentence carries distinct information and none repeats the title or schema.

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?

For a 6-parameter mutation tool with rich annotations but no output schema, the description covers trigger, return shape, and the sibling exclusion. The one real gap is that it never states that unspecified optional fields (name, description, group, order) stay unchanged, which matters for a partial-update call.

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%, so baseline would be 3; the description earns an extra point by mapping user intents to fields (renamed -> name, described differently -> description, moved into/out of a group -> group, moved up or down -> order), which helps intent-to-parameter mapping. It does not address whether omitted optional parameters are left untouched, which is the main semantic ambiguity remaining.

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 names the resource (a service or group on a status page) and enumerates the concrete mutations: rename, re-describe, move between groups, reorder. It explicitly distinguishes itself from the sibling remove_status_page_component, and the scope is narrow enough to separate it from update_status_page.

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?

Opens with an explicit trigger condition ("Use this when the user wants...") covering four distinct change intents, then states a when-not rule with the alternative named (removal -> remove_status_page_component). Nothing is left to inference about routing.

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