about_sparks_scribeWhat Sparks Scribe is, who it's for, and what the app does (shift notes with voice input, NDIS-coded invoicing, calendar/roster, client records, kilometre log).
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate read-only and idempotent behavior. The description adds value by specifying the content of the output: app features, target audience, and functionality. Provides sufficient behavioral context beyond structured fields.
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?
The description is a single sentence that efficiently conveys the tool's purpose and scope. No unnecessary words, front-loaded with key information. Every part 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?
Given the tool's simplicity (no parameters, no output schema, read-only), the description provides complete context: what the tool is, who it's for, and what it covers. No gaps left for the agent to infer.
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?
Input schema has 0 parameters with 100% coverage. The description adds meaning by explaining the tool's purpose and output, compensating for the lack of parameters. It fully informs what the tool does.
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 is informational about Sparks Scribe, listing its key features like shift notes, invoicing, calendar, client records, and kilometre log. It distinguishes itself from siblings (example_shift_note, get_pricing, get_trial_info) by being a general overview tool.
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 explicit guidance on when to use this tool versus siblings, but the context suggests it is for general information about the app. Implied usage is clear, but alternatives not discussed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool has a clearly distinct purpose: about describes the app, example provides a sample note, pricing gives cost info, trial explains the trial. No overlap.
All tool names follow a consistent pattern: descriptive noun phrases with underscores (about_sparks_scribe, example_shift_note, get_pricing, get_trial_info).
With 4 tools, the server is well-scoped for an informational resource about Sparks Scribe. Each tool addresses a key user need without being too sparse or excessive.
The tool surface covers the main informational needs: definition, example, pricing, and trial. A minor gap is the lack of a tool for support or FAQ, but the core functionality is complete.