Search imported local school snapshots for literal text and return line-numbered snippets. Use it to find notes in saved course material; it does not query live Brightspace.
Search manually imported local school snapshots with line-numbered snippets. These are not live Brightspace checks.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum snippets. | |
| query | Yes | Literal case-insensitive text to find. |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, closed-world, and non-destructive behavior, so the safety profile is covered. The description adds valuable context beyond that: results are line-numbered snippets and the data source is locally imported static snapshots rather than live data, which warns the agent that results may be stale.
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 sentences, zero waste, with the core capability front-loaded and the non-live caveat immediately following. Every sentence earns its place.
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?
For a simple two-parameter read-only search tool with rich annotations, the description covers purpose, data source, and result format. Return-value detail is not needed beyond the mention of line-numbered snippets, so it is essentially complete.
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%, with both 'query' (literal case-insensitive text) and 'limit' fully documented in the schema. The description adds only the notion of 'snippets' and does not elaborate on query syntax or limit behavior, so the baseline of 3 is appropriate.
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 states a specific verb ('Search') and resource ('manually imported local school snapshots'), and adds that results come as line-numbered snippets. It implicitly distinguishes itself from live checks ('These are not live Brightspace checks') but never names the live sibling like brightspace_search_course, so the differentiation is not fully explicit.
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?
The line 'These are not live Brightspace checks' signals the appropriate context (searching imported snapshots rather than live data), which is useful implied guidance. However, it never states when to prefer this over brightspace_search_course or brightspace_read_note, leaving the agent to infer the routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.