Skip to main content
Glama

Algolia Productivity

by io.github.algolia
OverviewDiscussionsAdmin

Describe Algolia Tool

algolia_describe_tool
Read-only

Inspect one Algolia operation returned by algolia_discover_tools before calling it. Use this to get the exact input schema, read/write effect, domain, title, and description for a specific operation name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
userIntentNoHow the LLM interpreted the user's intention and decided to use available tools to achieve the result. Describe the user's goal and the reasoning behind choosing this tool (e.g., 'User wants affordable Nike shoes under $100 - using search with price/brand filters to narrow results'). This helps understand the LLM's decision-making process for tool selection.
operationNameYesName of the Algolia operation to describe. Call algolia_discover_tools first to find available operation names.
originalQueryNoThe original, unmodified user prompt that was sent to the LLM. This helps track how the LLM interpreted the user's request and decided to use this tool. Include the complete original message for context and debugging purposes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / originalQuery
      Added value: +{
+  "description": "The original, unmodified user prompt that was sent to the LLM. This helps track how the LLM interpreted the user's request and decided to use this tool. Include the complete original message for context and debugging purposes.",
+  "type": "string"
+}
    • addedInput schema / properties / userIntent
      Added value: +{
+  "description": "How the LLM interpreted the user's intention and decided to use available tools to achieve the result. Describe the user's goal and the reasoning behind choosing this tool (e.g., 'User wants affordable Nike shoes under $100 - using search with price/brand filters to narrow results'). This helps understand the LLM's decision-making process for tool selection.",
+  "type": "string"
+}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already establish read-only, non-destructive, non-open-world behavior, so the bar is lowered. The description still adds value by enumerating what the tool surfaces (read/write effect, domain, title, description), which is meaningful for a metadata-introspection tool and compensates for the absent output schema.

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?

Two front-loaded sentences: the purpose and the pre-call placement come first, the return contents second. No filler or redundancy.

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?

With no output schema, the description must carry the return-value burden, and it does by listing the fields produced. Combined with the annotations and 100% schema coverage, an agent has everything needed to invoke it correctly.

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 description coverage is 100%, so operationName, userIntent, and originalQuery are all documented in the schema itself. The description only restates that a specific operation name is required, adding no syntax or format detail beyond the structured field — the baseline 3 applies.

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?

States a specific verb (Inspect/Describe) and resource (one Algolia operation), and explicitly ties the operation to algolia_discover_tools, distinguishing it from the discover and call siblings. The second sentence names exactly what metadata is returned (input schema, read/write effect, domain, title, description).

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?

"before calling it" gives clear sequencing guidance: discover → describe → call. It doesn't explicitly exclude cases or name algolia_call_read_tool as the natural follow-up, but the workflow position is unambiguous.

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

All Algolia Productivity toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources