Get vendor
sosinventory_get_vendorOne vendor by id with all fields. GET /api/v2/vendor/{id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | SOS vendor id (from sosinventory_list_vendors). |
sosinventory_get_vendorOne vendor by id with all fields. GET /api/v2/vendor/{id}.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | SOS vendor id (from sosinventory_list_vendors). |
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 needs no restating. The description adds real value with "with all fields" (no field projection is applied) and the underlying GET endpoint, but says nothing about auth, rate limits, or error/not-found behavior.
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 clipped sentences, front-loaded with the substance (single vendor, all fields) and the endpoint as a trailing technical footnote. No filler, though the endpoint adds little for most agents.
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 annotation coverage and a fully described schema, this is largely sufficient. The only residual gap is the absence of an output schema combined with no hint of the returned record's shape beyond "all fields".
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% and the schema itself explains that the id comes from sosinventory_list_vendors, so the parameter is fully documented in structured data. The description adds nothing beyond that, which meets the baseline.
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 ("One vendor by id") plus the scope of the return ("all fields"), which distinguishes it from the list_vendors sibling that returns many. It stops short of naming the sibling explicitly, so it is clear but not maximally differentiated.
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: you fetch this when you already have a vendor id, and the id schema note points back to sosinventory_list_vendors as the source of ids. There is no explicit when-to-use/when-not statement or named alternative.
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.