GetEndpointDetailGet the full schema for a specific Secureship API endpoint — all parameters, request body fields, response format, and authentication requirements. Use after SearchDocs identifies the right endpoint. Authentication uses the X-API-KEY header.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Endpoint path, e.g. /v1/shipment/in-progress or /v1/carriers/rates | |
| method | Yes | HTTP method: GET, POST, PUT, PATCH, or DELETE |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true and destructiveHint=false, and the description aligns by describing a read operation. It adds valuable context beyond annotations: authentication via X-API-KEY header and the specific scope of returned data. This is helpful but does not cover error cases or rate limits.
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 sentences, front-loaded with the core purpose, followed by usage context and authentication note. No wasted words; every clause adds 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 simple two-parameter tool with no output schema, the description covers purpose, when to use, returned content, and authentication—enough for correct selection and invocation. The mention of SearchDocs provides workflow context.
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?
The input schema already provides 100% coverage for both parameters (method and path) with clear descriptions and examples. The tool description does not add further parameter-level meaning, so baseline 3 applies.
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 retrieves the full schema for a specific Secureship API endpoint, enumerating contents (params, request body, response format, auth). This distinguishes it from siblings like SearchDocs or ListEndpoints, which locate endpoints rather than fetch detailed schemas.
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?
Explicitly says 'Use after SearchDocs identifies the right endpoint,' providing clear context for when to invoke this tool. However, it does not mention when not to use it or alternative tools like ListEndpoints, so it stops short of the full 'when/when-not/alternatives' ideal.
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 with no overlap: GetAuthInfo provides authentication instructions, ListEndpoints offers discovery, SearchDocs enables targeted searching, and GetEndpointDetail gives detailed schemas. The descriptions explicitly guide when to use each tool, preventing misselection.
All tool names follow a consistent verb_noun pattern (GetAuthInfo, GetEndpointDetail, ListEndpoints, SearchDocs) with clear, descriptive naming. There are no deviations in style or convention, making the set predictable and readable.
With 4 tools, this server is well-scoped for its purpose of API documentation and discovery. Each tool earns its place by covering essential steps: authentication guidance, endpoint listing, searching, and detailed schema retrieval, without being overly sparse or bloated.
The tool set provides complete coverage for the domain of API exploration and usage. It supports the full workflow from initial authentication to endpoint discovery, search, and detailed schema access, with no obvious gaps that would hinder an agent in interacting with the Secureship API.