Skip to main content
Glama

search_promotions

Search for promotions by keyword to locate specific campaigns like anniversary or Black Friday, returning IDs for further detail retrieval.

Instructions

依關鍵字搜尋促銷活動。

【用途】 快速找到特定名稱的促銷活動,例如搜尋「週年慶」、「黑五」等。 搜尋結果含 id 可進一步呼叫 get_promotion_detail 取得完整資訊。

【呼叫的 Shopline API】

  • GET /v1/promotions/search

【回傳結構】 dict 含 total_found, returned, items[]。 每筆包含 id, title, status, discount_type, start_at, end_at。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keywordYes搜尋關鍵字(促銷名稱)
max_resultsNo最多回傳筆數
Behavior3/5

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

Discloses the API endpoint and return structure, which is useful. However, no annotations exist, so the description should also mention that this is a read-only operation or require any permissions, but it doesn't.

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?

Well-structured with sections, front-loading the purpose. Each sentence adds value, though it could be slightly shorter without losing clarity.

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?

Given no output schema, it adequately describes the return structure and fields. It also explains integration with get_promotion_detail. However, it lacks information on pagination or error responses.

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 coverage is 100%, and the description adds marginal value beyond the schema. It re-iterates keyword and max_results but does not explain how they affect search behavior (e.g., partial match) beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states it searches promotions by keyword, with examples like '週年慶'. Although it differentiates from get_promotion_detail by noting results include IDs for that call, it could explicitly distinguish from list_promotions.

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?

Provides context for when to use (finding specific promotions by name) and mentions get_promotion_detail as next step, but does not explicitly say when not to use or provide alternatives like list_promotions.

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/asgard-ai-platform/mcp-shopline'

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