Skip to main content
Glama
tzangms

shopline-mcp

by tzangms

list_product_subscriptions

Retrieve a list of product subscriptions with status, frequency, and next billing date. Use it to analyze subscription revenue and customer retention.

Instructions

取得商品訂閱列表。

【用途】 瀏覽所有商品訂閱紀錄,了解客戶訂閱哪些商品、訂閱狀態與週期設定。 可取得 subscription_id 後進一步呼叫 get_product_subscription_detail 查詢完整詳情。 適合分析訂閱收入與客戶留存率。

【呼叫的 Shopline API】

  • GET /v1/product_subscriptions

【回傳結構】 dict 含 total_found, returned, items[]。 每筆包含 id, customer_id, product_id, status, frequency, next_billing_at, created_at。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
max_resultsNo最多回傳筆數
Behavior4/5

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

With no annotations provided, the description carries the behavioral transparency burden. It compensates by disclosing the return structure (dict with total_found, returned, items[] and item fields) and the API endpoint GET /v1/product_subscriptions. This goes beyond a basic statement, though it does not explicitly mention it is read-only or discuss pagination behavior.

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 well-structured with sections for purpose, usage, API endpoint, and return structure. The first sentence front-loads the purpose, and every section adds meaningful information without redundancy. It is appropriately sized for the tool's simplicity.

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 having no output schema, the description provides a complete overview: it explains what the tool does, how to use it (with a pointer to the detail tool), the API endpoint, and the exact return structure. This is fully sufficient for a list tool with one optional parameter.

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% for the only parameter (max_results with '最多回傳筆數'), so the schema already fully documents it. The description adds no additional parameter semantics, leaving the baseline at 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?

The description clearly states the tool '取得商品訂閱列表' (get product subscription list) with a specific verb and resource. It further elaborates on listing all subscription records to understand customer subscriptions, statuses, and cycle settings, and explicitly references the sibling tool get_product_subscription_detail for full details, distinguishing it from similar list 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?

The description gives explicit usage context: it is suitable for analyzing subscription revenue and customer retention, and it advises calling get_product_subscription_detail after obtaining subscription_id for complete details. This provides a clear alternative and conditions for use, fulfilling the when/alternatives guidance.

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/tzangms/shoplinemcp'

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