Skip to main content
Glama

vs_indexes_get

Read-only

Retrieve details of a Vector Search index by providing its fully-qualified name, such as 'catalog.schema.index'.

Instructions

Get a Vector Search index (GET /api/2.0/vector-search/indexes/{index_name}).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
index_nameYesFully-qualified index name, e.g. 'catalog.schema.index'

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, so the description's added value is the HTTP method and endpoint path. It does not elaborate on behavior like error handling or what is returned, but given annotations, a 3 is appropriate.

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

Conciseness4/5

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

The description is concise with one sentence and the endpoint path. No unnecessary text, but could be slightly more informative without being verbose.

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

Completeness3/5

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

With an output schema and simple input, the description is adequate but minimal. It could mention that it retrieves index configuration details, which would improve completeness without relying on the output schema.

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 coverage is 100% and the schema description for index_name is detailed ('Fully-qualified index name, e.g. 'catalog.schema.index''). The tool description adds no additional parameter semantics, only echoing the endpoint. Baseline 3.

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 tool retrieves a Vector Search index, using the specific verb 'Get' and resource 'Vector Search index'. It distinguishes from sibling tools like vs_indexes_list, vs_indexes_create, and vs_indexes_delete.

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?

No guidance on when to use this tool vs alternatives. No mention of prerequisites (e.g., index must exist) or scenarios where this is preferred over vs_indexes_list or vs_query_index.

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