Search Posts

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

Annotations already declare readOnly, idempotent, and open-world behavior, so the safety profile is covered. The description adds meaningful traits beyond that: result ordering is newest-first and muted channels are silently excluded by default, which is a subtle omission an agent would otherwise miss. Return format is covered by the output schema.

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?

Two short paragraphs, zero filler. The core operation is front-loaded in the first sentence and the syntax guidance follows as a compact parenthetical.

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?

Covers operation, ordering, syntax, and the muted-channel caveat, with parameters and return shape handled by schema and output schema. What remains unstated is how limit interacts with ordering and whether pagination is available, a minor gap for a search tool.

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 coverage is 100%, so the baseline is 3. The description earns more by documenting the query parameter's supported search syntax (from:, in:, before:/after:/on:, quoted phrases, negation) and by restating the include_muted default — real semantic value the schema's "Search terms" text does not provide.

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?

States a specific verb and resource ("Full-text search across Mattermost posts") plus result ordering ("newest first"). This clearly separates it from get_channel_posts, get_pinned_posts, and search_users, which are scoped or resource-specific.

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?

Gives a clear usage condition: default searching excludes muted channels, and include_muted=True widens scope. It does not explicitly contrast with siblings like get_channel_posts for single-channel retrieval or get_mentions for directed messages, so routing is partly left to inference.

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