Skip to main content
Glama

help

Get usage guidance for Hive by passing a topic for targeted instructions, or omit the topic to receive a general overview of features.

Instructions

Hive usage guidance. Omit topic for an overview, or pass one of: workflow, profiles, agents, wakes, projects, identity, actors, pads, todos, kv, leases.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.3/5.0
Behavior3/5

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

No annotations are present, so the description carries the full burden of behavioral disclosure. It discloses the two usage modes and the allowed topic set, but it does not explicitly state that the tool is read-only, what the output format is, or what happens with an invalid topic; these are minor gaps for a help utility but still leave some behavior unspecified.

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?

A single sentence that front-loads the purpose, states the default behavior, and lists the accepted values. There is no filler or repetition of structured information.

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 one-optional-parameter, no-output-schema help tool, the description covers the invocation modes and all accepted topic values. It does not describe invalid-topic behavior, but that is a minor omission for such a low-complexity tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema only defines topic as a string with no description or enum, so the description must compensate. It fully compensates by explaining that omitting the parameter yields an overview and by enumerating all eleven valid topic values, giving an agent everything needed to invoke the tool correctly.

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 opening phrase 'Hive usage guidance' names both the resource and the purpose, and the rest of the sentence specifies the exact behavior: omit for an overview or pass one of the listed topics. This clearly distinguishes the help tool from the dozens of operational siblings by marking it as meta-guidance rather than an action.

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?

The description gives explicit invocation guidance: omit the topic for an overview, or pass one of the enumerated topics for targeted help. It does not state a 'when not to use' condition, but since help is the only meta-tool among the siblings, no alternative tool competes with it.

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