Claude Platform Docs

Read API endpoint reference

get_api_endpoint

Read-onlyIdempotent

Get detailed information about a specific API endpoint including parameters, request body, and responses.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "method": "<method>",
      "path": "<path>"
    },
    "name": "get_api_endpoint"
  }
}

Input Schema

Name	Required	Description
`path`	Yes	API path (e.g., /v1/messages)
`method`	Yes	HTTP method
`sdk_language`	No	Language of the endpoint's types and code example. Default: http (a cURL example).

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedOct 26, 2026

addedInput schema / properties / sdk_language

Added value: +{
+  "description": "Language of the endpoint's types and code example. Default: http (a cURL example).",
+  "enum": [
+    "http",
+    "cli",
+    "typescript",
+    "python",
+    "java",
+    "go",
+    "ruby",
+    "csharp",
+    "php"
+  ],
+  "type": "string"
+}

First observedOct 20, 2026

TDQS

B3.4/5.0

Behavior3/5

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

The annotations already declare this is a read-only, idempotent, non-destructive, non-open-world lookup. The description adds useful context about what content is returned: parameters, request body, and responses. It does not add further behavioral details such as error handling or lookup constraints, which is acceptable given the annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence with no wasted words. It conveys the tool's purpose and returned information efficiently.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple, read-only reference lookup with fully described input schema and annotations covering safety behavior, the description is largely complete. It explains the kind of information returned even though no output schema exists, but it omits sibling routing guidance and any notes about lookup failures.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all three parameters, including the method/path requirements and sdk_language default, are already documented in the input schema. The description adds no parameter-level meaning beyond that, which is the expected baseline when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: getting detailed information about a specific API endpoint, including parameters, request body, and responses. It is clear what the tool does, but it does not explicitly distinguish itself from siblings such as get_doc or search_docs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no explicit guidance on when to use this tool versus alternatives. It implies usage by saying 'specific API endpoint,' but it never names get_doc, search_docs, or get_navigation or states when those should be preferred.

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

All Claude Platform Docs tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?