Retrieve the schema for a specific TimeBase stream by providing its stream key. Use this to inspect data structure and plan queries.
Get the schema of a specific stream
| Name | Required | Description | Default |
|---|---|---|---|
| stream_key | Yes | Stream key to inspect | |
| instance_key | No | TB instance key. Required when multiple TimeBase instances are configured. |
| Name | Required | Description | Default |
|---|---|---|---|
| stream_key | Yes | ||
| schema_text | Yes |
Changes observed during successful MCP inspections.
v0.2.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the read-only nature. The description adds no extra behavioral context (e.g., return format details, errors), but it does not contradict the annotations either.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence that conveys the essential purpose without any fluff. Perfectly concise for a simple read-only retrieval tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple (2 params, no nesting) and comes with a clear output schema and parameter descriptions. The description is sufficient to understand the tool's role, though it could briefly hint at the instance_key dependency for multi-instance setups, but the schema already covers that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with 'Stream key to inspect' and 'TB instance key. Required when multiple TimeBase instances are configured.' providing adequate parameter meaning. The description text itself adds no additional parameter insight, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's action ('Get') and resource ('schema of a specific stream'), making it easy to distinguish from sibling get_stream_* tools that retrieve time ranges, symbols, or messages.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives. It does not mention prerequisites like needing a stream_key, nor does it explain when instance_key is required, despite the sibling context showing many similar get_stream_* tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.