Skip to main content
Glama

get_keyword_search

Retrieve a keyword search's results by ID, including status, analytics summary, and posts. Detects oversized responses and pending results.

Instructions

Get results for a keyword search by ID. Returns search status, analytics summary, and posts. Oversized responses are truncated (truncated: true) — retrieve complete post data with get_keyword_search_posts. results_pending: true means the search succeeded but the backend is still writing results; retry in a few seconds.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesKeyword search ID
Behavior5/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It discloses truncation behavior and how to detect it (truncated: true), explains the meaning and handling of results_pending, and mentions the workaround for complete data. This is thorough and anticipates user needs.

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 three sentences, front-loading the core purpose and then adding necessary details about truncation and pending status. There is no wasted text; each sentence provides valuable information. The structure is clear and scannable.

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?

Given the tool has a single parameter, no output schema, and no annotations, the description covers all essential aspects: return content, truncation behavior, retry conditions, and cross-reference to a related tool. It is complete for the tool's complexity and leaves no critical gaps.

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 already describes the only parameter (id) with 100% coverage as 'Keyword search ID.' The description does not add additional semantics beyond this, but it adequately references the ID without needing further explanation. Baseline 3 applies because schema covers the parameter.

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?

Description starts with a specific verb+resource: 'Get results for a keyword search by ID.' It clearly states what is returned (search status, analytics summary, posts) and distinguishes itself from get_keyword_search_posts, which retrieves complete post data. The purpose is unambiguous and well-differentiated from sibling tools.

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

Usage Guidelines5/5

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

Provides explicit guidance on when to use this tool (to get results by ID) and when to use the alternative (get_keyword_search_posts) if responses are truncated. It also explains the results_pending state and advises retrying after a few seconds, offering actionable usage context.

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/rolliinc/rolli-mcp'

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