Skip to main content
Glama

Update Shared Step

update_shared_step
DestructiveIdempotent

Update an existing shared step in Allure TestOps, propagating changes to all test cases that use it. Modify optional fields like name or description while keeping omitted fields unchanged.

Instructions

Update an existing shared step. ⚠️ CAUTION: Destructive.

⚠️ IMPORTANT: Changes propagate to ALL test cases using this shared step.

Only provided fields will be updated. Omitted fields remain unchanged. Repeated calls with the same data are idempotent.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoNew name for the shared step (optional).
confirmNoMust be set to True to proceed with update. Safety measure.
step_idYesThe shared step ID to update (required).
project_idNoOptional override for the default Project ID.
descriptionNoNew description (optional).
output_formatNoOutput format: 'json' (default) or 'plain'.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
urlNo
nameNo
actionNoRequested operation name.
changedNo
step_idNo
updated_fieldsNo
requires_confirmationNo
Behavior4/5

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

Beyond annotations (destructiveHint, idempotentHint), the description adds critical context: changes propagate to ALL test cases, only provided fields are updated, and confirm must be True. This significantly informs the agent's usage.

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?

The description is concise, front-loaded with the action, and uses warnings effectively. Every sentence adds value with no fluff.

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?

Given the presence of an output schema, the description adequately covers key behaviors: propagation, idempotency, partial updates, and safety confirm. It lacks information about error handling or required permissions but is generally sufficient.

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% with clear descriptions. The description adds minimal extra meaning, only reinforcing the confirm parameter's role as a safety measure. Baseline 3 is appropriate.

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 clearly states 'Update an existing shared step,' specifying a concrete action and resource, distinguishing it from sibling tools like create_shared_step, delete_shared_step, etc.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear warnings about destructive impact and propagation to all test cases, emphasizes the need for confirm=True, and notes idempotency. While not explicitly contrasting with alternatives, the guidance is strong.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ivanostanin/lucius-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server