Skip to main content
Glama

annotatedMessage

Demonstrates annotation usage for metadata in content, showing different patterns for error, success, and debug messages with optional image examples.

Instructions

Demonstrates how annotations can be used to provide metadata about content

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageTypeYesType of message to demonstrate different annotation patterns
includeImageNoWhether to include an example image

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.6/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. The description only states it 'demonstrates how annotations can be used', which doesn't reveal whether this is a read-only operation, if it has side effects, what it returns, or any performance characteristics. For a tool with no annotation coverage, this leaves critical behavioral traits unspecified.

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, straightforward sentence that efficiently conveys its core idea without unnecessary words. It's appropriately sized for a demonstration tool, though it could be more front-loaded with actionable information about what the tool actually produces or does.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has no annotations and no output schema, the description is incomplete. It doesn't explain what the tool returns (e.g., a sample annotated message, a demonstration output), how the parameters affect the demonstration, or any educational context. For a tool with 2 parameters and no structured output documentation, more detail is needed to make it fully usable.

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 description coverage is 100%, with clear descriptions for both parameters ('includeImage' and 'messageType'), including an enum for messageType. The description adds no parameter-specific information beyond what the schema already provides. With high schema coverage, the baseline score of 3 is appropriate as the description doesn't compensate but also doesn't detract.

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

Purpose3/5

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

The description states the tool 'demonstrates how annotations can be used to provide metadata about content', which gives a vague purpose but doesn't specify what the tool actually does operationally. It mentions 'annotations' and 'metadata' but lacks a clear verb+resource combination. Compared to siblings like 'echo', 'add', or 'getResourceLinks', it doesn't clearly differentiate its specific function beyond being a demonstration tool.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention any specific contexts, prerequisites, or exclusions. Given siblings like 'echo' (for echoing input) or 'sampleLLM' (for LLM sampling), there's no indication of when this demonstration tool would be preferred over others for testing or educational purposes.

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