List vendors
fieldpulse_list_vendorsList vendors (suppliers). GET /vendors.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Records per page, 1-100 (default 25). | |
| search | No | Free-text search string. |
fieldpulse_list_vendorsList vendors (suppliers). GET /vendors.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Records per page, 1-100 (default 25). | |
| search | No | Free-text search 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, openWorldHint=true, and destructiveHint=false, covering the safety profile. The description adds nothing behavioral beyond that — no note on pagination defaults, result ordering, or search behavior — it only restates the HTTP endpoint, which is not useful to an agent.
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 fragments, front-loaded with the resource name; nothing is padded. The GET /vendors line is arguably wasted text since no other vendor endpoint is exposed via HTTP path here.
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-optional-parameter read tool with full annotation coverage, the description is minimally adequate. It omits any hint about the shape or size of the returned vendor list (no output schema exists), leaving the agent to discover that at call time.
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 description coverage is 100%, so limit and search semantics (range 1-100, default 25, free-text) are fully documented in the schema. The description contributes no additional meaning, which is acceptable given the schema baseline of 3.
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 ("List vendors") and adds the synonym "suppliers" to broaden recognition. It is distinguishable from the singular fieldpulse_get_vendor by the list verb, though it does not name that sibling explicitly.
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 guidance on when to use this versus fieldpulse_get_vendor or other list endpoints, and no prerequisites or exclusions. The agent must infer usage purely from the verb.
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.