Get part
synchroteam_get_partOne part or service by id or reference. GET /part/details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| by | Yes | Which identifier `value` is. | |
| value | Yes | The identifier. |
synchroteam_get_partOne part or service by id or reference. GET /part/details.
| Name | Required | Description | Default |
|---|---|---|---|
| by | Yes | Which identifier `value` is. | |
| value | Yes | The identifier. |
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 without the description. The description adds only that this is a single-record fetch against a specific endpoint; it says nothing about behavior on a missing or invalid id, which is the one gap an agent would care about here.
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, front-loaded with the resource and then the lookup keys, with zero filler. The trailing raw endpoint path is slightly redundant but not disruptive.
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 two-parameter read tool with high schema coverage and an annotations-declared safety profile, this is close to adequate. The gap is that there is no output schema and no description of what a part/service record contains or how the two are distinguished, leaving the return shape undocumented.
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% and the "by" enum is fully documented in the schema, so the parameters already carry their own meaning. The description's "by id or reference" merely restates the enum values rather than adding format, constraint, or ambiguity guidance.
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 names the resource precisely ("One part or service by id or reference") and clarifies that parts and services share this endpoint, which distinguishes it from a generic getter. It doesn't explicitly name the sibling to use for collections (synchroteam_list_parts), so it falls short of a 5.
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?
There is no statement of when to use this tool versus synchroteam_list_parts or the other get_* siblings. The phrase "by id or reference" implies a single-record lookup, but that is inferred rather than stated, and no prerequisites or exclusions are 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.