Skip to main content
Glama

Get Help Center improvement proposal

kb_get_proposal
Read-only

Get full details for an improvement proposal in the workspace Help Center public knowledge base. This is separate from agent training data managed by the *_training_data tools.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "proposal_id": "<proposal_id>"
    },
    "name": "kb_get_proposal"
  }
}

Input Schema

NameRequiredDescriptionDefault
proposal_idYesUUID of the Help Center improvement proposal to retrieve.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds no behavior beyond that: no indication of what is returned, whether the proposal may be missing/inaccessible, or any auth constraint. It only restates the resource's location.

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?

Two short sentences, front-loaded with the action and resource. The second sentence is a disambiguation that earns its place, though it could have been used to also route against kb_list_proposals rather than only the training-data tools.

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-parameter read tool with no output schema, the definition covers the essentials: what is fetched, from where, and what it is not. Missing would be a note on the returned detail set, but with annotations carrying the safety profile and full schema coverage on the sole parameter, this is close to complete.

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?

There is a single parameter with 100% schema description coverage ('UUID of the Help Center improvement proposal to retrieve'), so the schema fully documents it. The description adds no format or lookup nuance beyond the schema, which is the baseline-3 case for high coverage.

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 (Get), a specific resource (full details for an improvement proposal), and its scope (workspace Help Center public knowledge base). It also pre-empts confusion with the training-data sibling family, so an agent can separate this tool's domain from the *_training_data group without reading other schemas.

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?

The description explicitly rules out the training-data tools, which is useful routing, but gives no guidance on when to use this versus kb_list_proposals (list of proposals) or kb_get_article. Usage is implied by the noun 'full details' rather than stated as an explicit when/when-not rule.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.