Skip to main content
Glama

shopee_search_hints

Read-only

Get Shopee's ranked search-bar hint panel for a keyword prefix, with each hint's rank position, category id and name, record type, and item ids where present. Use it when ranking or category context matters; prefer shopee_suggest for plain autocomplete strings. keyword is required, version selects hint protocol 1 or 2 (default 2), and region selects the storefront (my, sg, id, th, vn, ph, tw, br, mx, co, or cl, default my).

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": {
      "keyword": "<keyword>"
    },
    "name": "shopee_search_hints"
  }
}

Input Schema

NameRequiredDescriptionDefault
regionNoOptional Shopee storefront region: my, sg, id, th, vn, ph, tw, br, mx, co, or cl. Defaults to my.
keywordYesRequired keyword prefix, for example phone.
versionNoOptional hint protocol version, 1 or 2. Defaults to 2.

Output Schema

NameRequiredDescriptionDefault
dataYesThe tool result payload (shape varies per tool; see each tool's docs resource).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so safety is covered; the description adds that this hits a live search-bar hint panel and enumerates the payload fields (rank position, category, record type, item ids). It does not mention rate limits, pagination, or what an empty hint panel looks like, so it stops short of fully rich behavioral context.

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

Conciseness4/5

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

Front-loaded with purpose and return shape, then usage routing, then params — a sensible order with no filler. The final sentence largely duplicates schema-declared defaults and the region list, which costs a bit of density.

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?

For a 3-parameter read tool with an output schema, the description covers purpose, disambiguation from the nearest sibling, all parameter meanings, and the shape of the returned hints. Nothing an agent needs in order to call it correctly is missing.

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%, and the description's parameter sentences (keyword required, version 1/2 default 2, region list default my) essentially restate what the schema already documents. Useful as a quick recap, but it adds no format, syntax, or edge-case semantics beyond structured data — baseline 3.

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 and resource ('Get Shopee's ranked search-bar hint panel for a keyword prefix') and immediately enumerates what each result carries (rank, category id/name, record type, item ids). It explicitly distinguishes itself from the sibling shopee_suggest, so an agent can choose without opening either schema.

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?

Gives an explicit selection rule — use this when ranking or category context matters — and names the alternative (shopee_suggest) for the plain-autocomplete case. The when-to-use and when-to-use-something-else conditions are both present.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.