Get Endpoint

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The readOnlyHint annotation is consistent with the description's 'Get' and 'fetch' language. The description adds behavioral nuance beyond the annotation by noting that multiple endpoints are returned 'in one call' with identical detail, and that endpointIds is used 'instead of' endpointId, clarifying the expected call semantics.

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?

The description is two sentences with no redundant wording. Every clause adds value: what info is returned, how to fetch multiple endpoints, the batch limit, and the environment prerequisite.

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?

The description is complete for an agent to decide and call the tool: it lists the returned content categories, the required project context, the batch behavior, and the parameter selection rule. No output schema is needed since the expected content is described directly.

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 each parameter has a description that explains its role. The descriptions explicitly clarify the relationship between endpointId and endpointIds, including when to omit each, which fully conveys the parameter semantics.

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 ('Get') and resource ('endpoint'), enumerates the returned details (parameters, request body, responses, security schemes), and differentiates from siblings like list_endpoints and get_spec by emphasizing detailed per-endpoint information. The mention of fetching multiple endpoints via endpointIds further clarifies scope.

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?

Provides explicit when-to-use guidance by contrasting endpointIds with endpointId, specifies the maximum batch size (up to 25), and states the prerequisite ('Requires project context'). This leaves no ambiguity about when to call this tool versus alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.