search_api_index_getRetrieve a single Search API index by its ID from a Drupal site, optionally including related data. Use it to inspect index configuration or status for search setup.
Get a single Search API index by ID.
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | ||
| index_id | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden. It does not state that this is a read-only lookup, whether it requires permissions, or what happens when the index ID is invalid; for a simple get tool the risk is low, but no behavioral traits are disclosed.
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?
One clean, front-loaded sentence with no repetition or filler. It is appropriately sized for a simple lookup tool.
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?
An output schema exists, so return values need not be described. However, the description omits the include parameter and any usage guidance, and with zero schema description coverage the definition leaves an agent without a complete picture; it is minimally usable for a simple get but has clear gaps.
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 description coverage is 0%, so neither index_id nor include is documented in the schema. The description mentions 'by ID' but adds no format or meaning beyond the parameter name, and the include parameter is completely unexplained, failing to compensate for the coverage gap.
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 and resource ('Get a single Search API index') and scopes it to retrieval by ID, which implicitly separates it from the sibling search_api_index_list. It does not explicitly name the list tool as an alternative, so it falls short of full sibling differentiation.
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?
No when-to-use guidance, prerequisites, or alternative tools are mentioned. The operation is self-explanatory, but the description leaves all usage context to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.