Skip to main content
Glama

serving_endpoints_openapi

Read-only

Retrieve the OpenAPI schema for a Databricks serving endpoint to generate API documentation or client code.

Instructions

Fetch the OpenAPI schema for a serving endpoint (GET /api/2.0/serving-endpoints/{name}/openapi).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesServing endpoint name

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

Annotations already declare readOnlyHint=true, indicating a non-destructive read. The description adds that it returns an OpenAPI schema and includes the HTTP method/path, but does not elaborate on response details, which is acceptable given the output schema exists.

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?

Single sentence with no extraneous information. Includes the HTTP method and URL in parentheses for clarity. Every word serves a purpose.

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

Completeness5/5

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

For a simple read-only tool with one parameter and an output schema, the description sufficiently covers the tool's purpose and usage. No additional details are necessary.

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?

The only parameter 'name' is fully described in the schema with 'Serving endpoint name'. The description does not add further meaning, and with 100% schema coverage, the baseline score of 3 is appropriate.

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

Purpose5/5

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

The description clearly states the action ('Fetch the OpenAPI schema') and resource ('serving endpoint'). It distinguishes from siblings like serving_endpoints_get (which retrieves endpoint configuration) by specifying the schema type.

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

Usage Guidelines4/5

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

The description implies this tool is for obtaining the OpenAPI schema of a serving endpoint. While it doesn't explicitly mention when to use alternatives, the specialized function is clear enough to avoid confusion with other tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/inav/databricks-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server