Skip to main content
Glama

list_store_credits

Retrieve a list of all customer store credit balances, including total balance and individual amounts per customer. Use this to monitor credit liabilities and identify customers with high balances.

Instructions

取得所有客戶的儲值金餘額列表。

【用途】 瀏覽客戶儲值金餘額概況,了解儲值金發放與使用狀況。 可用於計算儲值金負債、找出高餘額客戶。

【呼叫的 Shopline API】

  • GET /v1/user_credits

【回傳結構】 dict 含 total_found, returned, total_balance, credits[]。 每個 credit 包含 customer_id, balance (TWD float)。

Input Schema

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

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

No annotations provided, so the description carries full burden. It discloses the return structure, API endpoint, and that it returns a list. The read-only nature is clear, but it does not mention pagination behavior beyond the max_results parameter.

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 concise and well-structured with sections for purpose, API call, and return structure. Every sentence adds value, and the main purpose is front-loaded.

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?

Given the tool's simplicity (one optional parameter, no output schema), the description adequately covers the return structure, API endpoint, and use cases. No gaps are apparent.

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 single optional parameter max_results. The description adds no additional meaning beyond the schema's existing description.

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 retrieves all customers' store credit balances and details its usage for browsing, liability calculation, and identifying high-balance customers. It distinguishes from siblings like update_customer_store_credits.

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?

The description provides specific use cases (e.g., calculating liabilities, finding high-balance customers) and implies it is for read-only purposes. However, it does not explicitly compare with other list tools or state when not to use.

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