Skip to main content
Glama

container_describe

Read-onlyIdempotent

Retrieves a knowledge container or source’s description and document statistics so agents can understand scope coverage and choose the right one before searching.

Instructions

Returns an agent-optimized description of a knowledge scope — container or source: its description and document statistics. Use this to understand what a scope covers before querying via search_knowledge, or when container_list output is insufficient to choose between them. The response also echoes the server's tool-routing instructions for clients that don't surface them on connect.

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": {
      "containerId": "<containerId>"
    },
    "name": "container_describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
containerIdYesContainer or source ID (GUID) or name

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, and the description adds non-obvious context: the response echoes the server's tool-routing instructions for clients that don't surface them on connect, and the payload includes document statistics. It does not state error behavior for unknown or ambiguous names, which is the main remaining gap.

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?

Purpose is front-loaded in the first clause, followed by usage guidance and return behavior, with no filler. Slight deduction for jargon like 'agent-optimized' and for the routing echo note, which is meta rather than task-relevant for calling the tool.

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?

With no output schema, the description carries the burden of describing return values and does so (scope description, document statistics, routing instructions). For a single-parameter read-only tool this is nearly complete, lacking only a note about behavior when the identifier matches nothing.

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 schema already documents the single parameter as a GUID or name. The description repeats 'container or source' but adds no resolution semantics, such as what happens with name collisions, so the baseline 3 applies.

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 description opens with a specific verb and resource: 'Returns an agent-optimized description of a knowledge scope — container or source', and states the returned contents (description plus document statistics). It also distinguishes itself from container_list by positioning itself as the tool for choosing between scopes when the list output is insufficient.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It names concrete usage contexts — before querying via search_knowledge, and as a fallback when container_list output is insufficient — so an agent can see two alternatives and the condition that selects this tool over them. The 'when the list is insufficient' clause effectively serves as the exclusion rule.

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