Skip to main content
Glama

aiworkhub_manager_kb_get

Read-only

MANAGER READ: exact canonical KB entry lookup.

Instructions

MANAGER READ: exact canonical KB entry lookup.

Input Schema

NameRequiredDescriptionDefault
keyYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes the safety profile, and the description adds the useful scope constraint that the lookup is exact and canonical. It does not disclose behavior for missing keys, but with a read-only annotation and an output schema, the added context is enough for a mid-range score.

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?

The description is a single front-loaded phrase with no filler. The 'MANAGER READ:' prefix is somewhat redundant given the readOnlyHint annotation, but the statement is otherwise appropriately concise.

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?

For a simple one-parameter read tool, the annotations and output schema cover safety and return values, so the description does not need to explain those. However, it leaves the key parameter's semantics undefined despite 0% schema coverage, which is a clear remaining gap.

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

Parameters2/5

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

The sole parameter, key, has 0% schema description coverage and the description does not explain what a canonical key is or what format it expects. The phrase 'exact canonical KB entry lookup' hints that key is a canonical identifier, but it does not compensate for the missing schema documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific resource and operation: an exact canonical KB entry lookup. The word 'exact' usefully distinguishes it from a fuzzy search sibling such as aiworkhub_manager_kb_search, though the sibling is not named explicitly.

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?

There is no explicit guidance on when to use this tool versus kb_search, kb_related, or kb_write. The reader can infer that it is for exact lookups, but the description does not state that condition or any exclusions.

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

Deploy Server

Other Tools