Skip to main content
Glama

get_affiliate_campaign_detail

Get complete details of an affiliate campaign including commission rules, tracking code, and validity period. Requires the campaign ID.

Instructions

取得單一聯盟行銷活動的完整詳情。

【用途】 查詢特定聯盟行銷活動的佣金規則、適用範圍與推廣連結等完整資訊。 適合在已知 campaign_id 的情況下取得所有欄位。

【呼叫的 Shopline API】

  • GET /v1/affiliate_campaigns/{campaign_id}

【回傳結構】 dict 包含 id, title, status, commission_type, commission_value, tracking_code, start_at, end_at, created_at, updated_at 等完整欄位。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
campaign_idYes聯盟行銷活動 ID(由 list_affiliate_campaigns 回傳的 id 欄位)
Behavior3/5

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

No annotations provided, so description carries full responsibility. It mentions the API method (GET) indicating a read operation, but does not explicitly state idempotency, rate limits, or authentication requirements. The description is adequate but could be more explicit about the read-only nature.

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?

Description is concise and well-structured with clear sections (用途, API call, return structure). Every sentence adds value, and no redundant information exists.

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?

Despite no output schema, the description details the return structure (dict with specific fields) which compensates. Given the simplicity of the tool (single parameter, no nested objects), the description fully covers what the agent needs to know for correct invocation.

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 single parameter campaign_id is already described in the schema as being obtained from list_affiliate_campaigns. The tool description adds no new parameter semantics beyond that; since schema coverage is 100%, baseline score of 3 is appropriate.

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 clearly states the tool retrieves complete details of a single affiliate campaign, specifying it queries commission rules, scope, and promotion links. It distinguishes itself from sibling tools like list_affiliate_campaigns and update_affiliate_campaign by focusing on detail retrieval for a known campaign_id.

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?

Description indicates proper use is when campaign_id is known, implying prior use of list_affiliate_campaigns. It provides clear context for use but does not explicitly exclude alternatives or state when not to use this tool.

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