Skip to main content
Glama

hb_describe_operation

Read-onlyIdempotent

Retrieves complete details for a single Hub API operation—parameters, body schema, required fields, scope, side effects, errors, and an example call—to review before executing writes.

Instructions

Full detail of one operation: parameters, body schema with required fields and an example, required scope, side effects (credits, health data, destructive, idempotency), documented errors, and a ready example call for hb_call_operation. Read this before any write.

Input Schema

NameRequiredDescriptionDefault
operation_idYese.g. hub.candidates.list

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.3

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive), and with no output schema the description does real work by disclosing that side effects (credits, health data, destructive, idempotency) and documented errors are returned. It doesn't state pagination, size limits, or behavior for invalid operation_ids, keeping it out of the top band.

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?

A single dense but well-ordered sentence that front-loads the return contents and closes with the actionable directive 'Read this before any write.' No filler, though the enumerated list is long enough to border on a run-on.

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

Completeness5/5

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

With no output schema, the description must explain what comes back, and it does so exhaustively: parameters, body schema with required fields and an example, required scope, side effects, errors, and a ready-to-use call. Nothing an agent needs before invoking it is missing.

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% and the single operation_id parameter already carries an example ('hub.candidates.list'); the description adds no further semantics about the identifier format or lookup behavior beyond referencing the example call. Baseline 3 applies when the schema does the heavy lifting.

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?

States a specific verb/resource ('Full detail of one operation') and enumerates exactly what it returns, which cleanly separates it from hb_search_operations (find operations) and hb_call_operation (execute one). An agent can pick this without opening the schema.

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?

'Read this before any write' gives a clear directive on when to invoke it and implicitly positions it as the precursor to hb_call_operation. It stops short of naming explicit alternatives or when-not-to-use conditions, so it's strong but not exhaustive.

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