Skip to main content
Glama

processDefinition_getByKey

Retrieve the latest deployed version of a process definition using its key to access metadata like version, deployment ID, and start form key.

Instructions

Retrieve the latest deployed version of a process definition by its key. Returns full metadata including version, deployment ID, and start form key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

With no annotations provided, description carries the full burden. It discloses critical behavioral traits: returns 'full metadata' and specifically fetches the 'latest deployed version' (not arbitrary versions). Mentions specific returned fields (version, deployment ID, start form key) compensating for missing output 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?

Two sentences with zero waste. First sentence front-loads the action and scope; second sentence details return value structure. Every word 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?

Given no output schema exists, description adequately compensates by listing returned metadata fields. However, lacks error handling disclosure (what happens if key not found?) and doesn't explicitly confirm read-only safety despite 'Retrieve' verb implying it.

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?

Input schema contains 0 parameters, establishing baseline 4 per rubric. Description mentions 'by its key' implying a key identifier is required, though schema doesn't show where this is provided (likely path parameter). No additional parameter context needed for empty schema.

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?

Description uses specific verb 'Retrieve' with clear resource 'process definition' and scope 'latest deployed version by its key'. The 'by its key' phrase effectively distinguishes this from sibling processDefinition_getById.

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?

No explicit when-to-use guidance or named alternatives. While the 'by key' qualifier implies distinction from ID-based lookup, it doesn't state when to prefer this over getById or list operations, nor mention prerequisite requirements like deployment existence.

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/operaton/operaton-mcp'

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