Skip to main content
Glama

Search Api Facet List

search_api_facet_list

List Search API facets with their facet_source_id, enabling you to match facets to an index. Use this to retrieve available facets for a facet source.

Instructions

List Search API facets.

index_id is no longer applied. A facet is attached to a facet source, not to the index, and the only field it carries is facet_source_id -- so filter[index] answered 400 "the field index does not exist" on every call, and there is no field to filter on instead. Each returned facet carries its facet_source_id, which is what a caller needs to match facets to an index.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
index_idNo
page_limitNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full disclosure burden. It does add real value by explaining that index_id is ignored and that filter[index] returned a 400, but it says nothing about pagination behavior, the 50-item default, or whether the call is a safe read.

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

Conciseness3/5

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

Purpose is correctly front-loaded, but the second sentence rambles through a nested em-dash explanation and an inline quoted error before restating the same point twice ('no field to filter on', 'there is no field to filter on instead'). It could be tightened considerably.

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?

An output schema exists, so return-value documentation is not required; the description still adds the important detail that each returned facet carries facet_source_id. The main gap is the unexplained page_limit parameter.

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 0%, so the description must compensate. It thoroughly explains index_id (deprecated/ignored), which is exactly the kind of meaning the schema lacks, but page_limit is entirely unexplained despite being the remaining parameter.

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?

Opens with a specific verb and resource ('List Search API facets'), so the operation is unambiguous. It distinguishes itself from create-style siblings (search_api_facet_create) by being a read/list operation, though it never names siblings directly.

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

Usage Guidelines3/5

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

The note that 'index_id' is no longer applied is genuinely useful usage context (it tells the caller not to bother filtering by index), but the description never states when to choose this tool over alternatives or what the intended calling context is.

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

Deploy Server

Other Tools