Get transaction
farmbrite_get_transactionOne transaction by id. GET /transactions/{transaction_id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| transaction_id | Yes | Transaction id (a Farmbrite id string). |
farmbrite_get_transactionOne transaction by id. GET /transactions/{transaction_id}.
| Name | Required | Description | Default |
|---|---|---|---|
| transaction_id | Yes | Transaction id (a Farmbrite id string). |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds only the REST endpoint path, hinting this is a direct API passthrough; it says nothing about auth needs, 404/not-found behavior, or what a transaction object contains.
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 terse sentences, zero filler, with the core purpose front-loaded before the endpoint detail. Nothing here could be cut without losing information.
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 one-parameter read tool with full schema coverage and read-only annotations, the minimum needed to call it correctly is present. However, there is no output schema, and the description does not characterize the returned transaction (fields, money vs. inventory transaction, nesting), leaving the agent blind on results.
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 a single required transaction_id that already documents the id format and constraints, so baseline is 3. The description's 'by id' adds no syntax, format, or sourcing guidance beyond the schema.
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 resource and cardinality ('One transaction by id') and gives the underlying endpoint GET /transactions/{transaction_id}, which makes the single-record retrieval unambiguous. It implicitly contrasts with the list sibling via 'One', but never names farmbrite_list_transactions.
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?
Usage is only implied: 'by id' signals that you need a known identifier, so an agent can infer this is not a search/browse tool. There is no explicit statement of when to use this versus farmbrite_list_transactions or the create/update siblings, and no prerequisites given.
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.