Skip to main content
Glama

get_keyword_search

Fetch keyword search results by ID to review status, analytics summary, and posts; truncated responses require paged retrieval of the full post list.

Instructions

Get results for a keyword search by ID. Returns search status, analytics summary, and posts. Oversized responses are truncated (truncated: true) — read the complete post list in pages with get_keyword_search_posts (offset, limit, fields=lean, one platform at a time). results_pending: true means the search succeeded but the backend is still writing results; retry in a few seconds.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "get_keyword_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesKeyword search ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.5.0
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / id / maximum
      Added value: +9007199254740991
  2. First observedv1.1.7

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the return surface (status, analytics summary, posts), the truncation signal (truncated: true), and the asynchronous backend state (results_pending: true with a retry hint). It stops short of stating read-only semantics, error behavior, or any rate limits, which is the remaining gap.

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?

Three dense sentences with zero filler, front-loaded with purpose before branching into the truncation workaround and the pending-state retry rule. Every clause carries operational information the agent needs.

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?

For a one-parameter read tool with no output schema and no annotations, the description covers the return shape, the truncation edge case, and the async pending case, which is most of what an agent needs. Minor omissions (no mention of error/not-found behavior or what the analytics summary contains) keep it from a 5.

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?

There is a single parameter at 100% schema description coverage ('Keyword search ID'), so the schema already does the work. The description only says 'by ID' and adds no format or sourcing detail beyond the schema, making the baseline 3 correct.

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+resource ('Get results for a keyword search by ID') and immediately distinguishes itself from the sibling that lists searches and from get_keyword_search_posts by describing what it returns (status, analytics summary, posts). An agent can pick it out of the crowded sibling list without opening the schema.

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?

Explicitly routes the agent to get_keyword_search_posts (with offset, limit, fields=lean, one platform at a time) when the response is truncated, and explains that results_pending: true should be retried in a few seconds. No guidance on how to obtain the id or when to prefer list_keyword_searches first, so it falls short of full when/when-not coverage.

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