Skip to main content
Glama

apex_add_faceted_search

Add faceted search filters to Oracle APEX Interactive Reports by defining facet columns, labels, and filter types. Enables users to refine report results with selectable filters.

Instructions

Add faceted search: filter SELECT_LISTs + IR. Facets: [{column, label, type}].

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
facetsYesList of facet descriptor dicts. Each must have: - ``"column"`` (str): Column name used in the bind variable and LOV. - ``"label"`` (str): Label shown next to the filter. - ``"type"`` (str): Filter widget type. Currently ``"checkbox"`` and ``"select"`` both produce a SELECT_LIST (with All option). - ``"lov"`` (str, optional): LOV SQL ``"SELECT display d, return r FROM ..."`` — auto-generated from ``DISTINCT column FROM table`` when omitted. Example:: [ {"column": "DS_STATUS", "label": "Status", "type": "select"}, {"column": "ID_CLINICA", "label": "Clinica", "type": "select", "lov": "SELECT DS_NOME d, ID_CLINICA r FROM TEA_CLINICAS ORDER BY 1"}, ]
page_idYesTarget page ID.
sequenceNoDisplay sequence for the filter region (IR gets +10).
sql_queryYesSQL for the Interactive Report with ``:{item_name}`` bind variables matching the facet items that will be created.
region_nameYesDisplay name of the main IR region.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

The description does not disclose behavioral side effects, such as whether existing filters are replaced or if any page re-render is required. Annotations indicate it is not read-only, but no additional context about destructive potential or permissions is provided.

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 extremely concise, using a compact format to convey the essence of the tool without unnecessary words. The schema carries the detail, making this appropriately sized and well-structured.

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?

Within the context of the rich schema and annotations, the description is adequate for understanding the tool's primary purpose, but it lacks information about prerequisites or side effects. Since an output schema is present, return values are covered elsewhere.

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 input schema provides 100% coverage with detailed descriptions, especially for the facets array. The description's mention of facet structure mirrors the schema but adds no new information beyond what is already documented.

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 adds faceted search, specifying that it filters SELECT_LISTs and IR. It distinguishes from sibling tools like apex_add_search_bar by its specific focus on facets.

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 description implies use when adding facet-based filtering to IR pages with SELECT_LISTs, but it does not explicitly contrast with alternatives or state exclusions. There is no mention of when not to use it or prerequisite conditions.

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/TechFernandesLTDA/apex-mcp'

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