Skip to main content
Glama

Get Shared Step

get_shared_step

Retrieve details of a specific shared step using its ID and project code.

Instructions

Fetch details for a single shared step by ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectCodeYesProject code identifier (e.g., BDI)
sharedStepIdYesIdentifier of the shared step

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesUnique identifier of the step
typeYesType of the step. Known values: "standalone" | "shared" | "shared_sub_step"
titleNoTitle of the step (only for shared steps)
versionYesVersion of the step
expectedNoExpected result from the step (HTML; only for standalone and shared_sub_step)
isLatestYesWhether this is the latest version of the step
subStepsNoSub-steps of a shared step, each with type 'shared_sub_step' (present only on shared steps)
deletedAtNoDate the step was deleted on (ISO 8601)
descriptionNoDetails of the step (HTML; only for standalone and shared_sub_step)
Behavior2/5

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

With no annotations and a minimal description, the tool's behavior is implied as a read operation, but no details are given about error handling, authentication, or side effects.

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 a single, concise sentence that immediately conveys the action and resource, with no superfluous words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description adequately covers the basic fetch operation for a simple tool with an output schema, but it lacks context on potential errors or what happens if the step does not exist.

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 baseline is 3. The description adds no additional meaning beyond what the schema already provides for the parameters.

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 uses the specific verb 'Fetch details' with the resource 'shared step' and specifies retrieval by ID, clearly differentiating from the sibling tool 'list_shared_steps' which lists multiple steps.

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 is provided on when to use this tool versus alternatives (e.g., list_shared_steps). The agent must infer usage from the name and description.

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/Hypersequent/qasphere-mcp'

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