LINE Shopping API MCP
Provides tools for managing LINE Shopping products, inventory, orders, settlements, and checkout links via the LINE Shopping API.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@LINE Shopping API MCPlist orders placed today"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
LINE Shopping API MCP Server
MCP Server for the LINE Shopping API, enabling AI agents and tools to interact with LINE Shopping data and operations via the Model Context Protocol. This server provides tools for managing products, inventory, orders, settlements, and more, using the official LINE Shopping API.
Features
Product Management: Search, create, update, and delete products and variants
Inventory Management: Adjust, increase, or decrease inventory levels
Order Management: Query, view, cancel, and update orders
Settlement: Retrieve settlement details for orders
OpenAPI Integration: All tools are auto-generated from the OpenAPI spec
Related MCP server: LineWhiz
Prerequisites
Python >= 3.13
uv (Python package manager)
LINE Shopping API Key (
X_API_KEY)
Installation
Method 1: Using uvx (Recommended)
Install and run directly from PyPI using uvx:
# Install and run the MCP server (note the different executable name)
uvx --from lineshopping-api-mcp lineshopping-mcpOr run with environment variables:
# Set your API key and run
X_API_KEY=your_api_key_here uvx --from lineshopping-api-mcp lineshopping-mcpMethod 2: Clone and Run
Clone the repository:
git clone https://github.com/woraphol-j/lineshopping-api-mcp.git cd lineshopping-api-mcpInstall dependencies:
uv add fastmcp httpxRun the server:
# Set your API key and run X_API_KEY=your_api_key_here uv run --with fastmcp fastmcp run app.py
Environment Configuration
For persistent configuration, create a .env file in your working directory:
X_API_KEY=your_api_key_hereConfiguration & Integration
Using uvx (PyPI Installation)
Configure your agent to use the PyPI-installed package:
{
"inputs": [
{
"type": "promptString",
"id": "line-shopping-api-key",
"description": "LINE Shopping API Key",
"password": true
}
],
"servers": {
"LINE Shopping API MCP": {
"command": "uvx",
"args": [
"--from",
"lineshopping-api-mcp",
"lineshopping-mcp"
],
"env": {
"X_API_KEY": "${input:line-shopping-api-key}"
}
}
}
}Using Local Clone
For local development or cloned repository:
{
"inputs": [
{
"type": "promptString",
"id": "line-shopping-api-key",
"description": "LINE Shopping API Key",
"password": true
}
],
"servers": {
"LINE Shopping API MCP": {
"command": "uv",
"args": [
"run",
"--with",
"fastmcp",
"fastmcp",
"run",
"/Users/xxx/lineshopping-api-mcp/app.py"
],
"env": {
"X_API_KEY": "${input:line-shopping-api-key}",
"FASTMCP_EXPERIMENTAL_ENABLE_NEW_OPENAPI_PARSER": "true"
}
}
}
}Available Tools
The following tools are exposed by the MCP server (see openapi.json for full details):
Checkout & Links
create-checkout-link: Generate a checkout link for order items
Inventory Management
adjust-inventory: Adjust inventory by IDdecrease-inventory: Decrease inventory by IDincrease-inventory: Increase inventory by ID
Order Management
get-orders: List orders with advanced filteringget-order-detail: Get details for a specific ordercancel-order: Cancel an ordermark-order-paid: Mark order as paid (COD)mark-order-shipped: Mark order as shipped and add tracking numberprint-parcel-label: Download parcel label for an ordersend-order-message: Send message via OA Plus flex messageupdate-shipment: Update shipping tracking number
Product Management
get-products: List/search productscreate-product: Create a new productdelete-product: Delete a productupdate-product-detail: Update product detailsdelete-product-variant: Delete a product variantupdate-product-display-status: Update product's display status (onsale/hide)update-product-price: Update product price and instant discountupdate-product-variant-detail: Update product variant detailscreate-product-variants: Create product variants
Settlement
get-settlement-detail: Get settlement details for an order
Refer to openapi.json for all available tools, input parameters, and response formats.
Debugging
If you run into issues, check your agent platform's MCP logs for errors. Common issues:
Authentication Errors: Verify your API key and environment variable setup
API Errors: Check rate limits, input formats, and required fields
Development
Local Development
# Clone the repository
git clone https://github.com/woraphol-j/lineshopping-api-mcp.git
cd lineshopping-api-mcp
# Install dependencies
uv add fastmcp httpx
# Run the server (with fastmcp)
X_API_KEY=your_api_key_here uv run --with fastmcp fastmcp run app.pyBuilding and Publishing
# Build the package
uv build
# Publish to PyPI (requires API token)
uv publish --token your_pypi_tokenDependencies
fastmcp - MCP protocol implementation
httpx - HTTP client for API requests
License
MIT
This project is not an HTTP REST API server. It is an MCP server for agent integrations. For more details, see FastMCP and LINE Shopping API.
Available Tools
22 toolsAdjust_inventoryC
API for updating inventory by adjusting the inventory amount from the current inventory on hand.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Inventory ID | |
| amount | Yes | Amount must greater than or equal to 0 and less than 100,000 (0 <= amount + availableNumber < 100,000) |
Output Schema
| Name | Required | Description |
|---|---|---|
| availableNumber | No | Quantity that is available and display on the storefront (Exclude ‘Reserved’ and ‘Ready to ship’ status) |
| onHandAmount | No | Quantity in stock (Include ‘Reserved’ and ‘Ready to ship’ status) |
| readyToShipAmount | No | Quantity that customers complete payment and wait to ship |
| reservedAmount | No | Quantity that customers do not complete payment |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided. The description does not disclose side effects, authentication needs, or whether the operation is destructive. It only says 'updating', which is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single short sentence, which is concise. However, it is too vague to be fully effective.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description lacks context about return values, how the amount interacts with current inventory, and does not leverage the presence of an output schema to add clarity. Sibling tools are not compared.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds no additional meaning beyond the schema, but does not contradict it either.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states it updates inventory by adjusting the amount, but it is ambiguous whether it sets absolute amount or adds a delta, especially given sibling tools Increase_inventory and Decrease_inventory.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use Adjust_inventory versus Increase_inventory or Decrease_inventory. The description does not mention any prerequisites or conditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Cancel_OrderD
An API for cancel order.
| Name | Required | Description | Default |
|---|---|---|---|
| orderNo | Yes | Order number | |
| remarkCancel | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| checkoutAt | No | Checkouted date |
| discountAmount | No | Total discount from the order price (excluding instant discounts applied to products) |
| isGift | No | If product is set to 'Allow gift' or 'Gift only' will be returned 'true' |
| lastUpdatedAt | No | Last updated date |
| orderItems | No | |
| orderNumber | No | Order number |
| orderStatus | No | Order status |
| paidAt | No | Paid date |
| paymentMethod | No | Payment method |
| paymentStatus | No | Payment status |
| remarkBuyer | No | Note from buyer |
| remarkRecipient | No | Remark recipient |
| shipmentDetail | No | |
| shipmentPrice | No | Total shipping fee |
| shipmentStatus | No | Shipment status |
| shippingAddress | No | |
| subtotalPrice | No | Subtotal price after applying instant discount to order items |
| totalPrice | No | Total order price (subtotalPrice + shipmentPrice - discountAmount) |
| weight | No | Total weight |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry the burden of disclosing behavioral traits. It does not mention any side effects, required permissions, irreversibility, or what happens upon cancellation, making it completely insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely short, but it is under-specified. Conciseness is valued, but here it comes at the cost of missing critical information, resulting in an ineffective description.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Even for a simple tool with two parameters and an output schema, the description fails to explain the output, prerequisites (e.g., order must exist), or post-conditions, making it contextually incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 50% (one of two parameters has a description). The main description adds no parameter-level context beyond the schema, failing to compensate for the missing parameter documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'An API for cancel order' essentially restates the tool name 'Cancel_Order' without adding specificity about what cancellation entails or how it differs from sibling tools like 'Order_detail' or 'Mark_as_paid_COD'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool, prerequisites (e.g., order status), or alternatives. The description is entirely absent of usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Create_checkout_linkC
An API for generate checkout link.
| Name | Required | Description | Default |
|---|---|---|---|
| orderItems | Yes | List of product for checkout link |
Output Schema
| Name | Required | Description |
|---|---|---|
| checkoutLink | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden of behavioral disclosure. It only states that the tool generates a checkout link, but does not mention side effects, idempotency, permissions, or whether it creates a record. This is insufficient for an agent to understand the tool's impact.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, achieving maximal conciseness. However, a minor grammatical error ('for generate' instead of 'to generate') slightly detracts from clarity, preventing a perfect score.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple (one parameter, no nested objects, with an output schema). The description covers the basic purpose, but fails to mention that the tool likely returns the generated link or any other contextual details. Given the output schema exists, the description is minimally adequate but not complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides descriptions for all parameters (100% coverage), including constraints (e.g., quantity range). The description adds no additional meaning beyond what the schema offers, so it meets the baseline but does not exceed it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: to generate a checkout link. It uses a specific verb and resource, matching the tool name. While there are no similar sibling tools for differentiation, the purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives, nor does it mention any prerequisites or context. The agent is left to infer usage from the tool name and purpose alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Create_productC
An API for product creation. For product Categories ID variable please find more information on Development guideline
| Name | Required | Description | Default |
|---|---|---|---|
| brand | No | Product brand | |
| categoryId | Yes | Product category id | |
| code | Yes | Product code | |
| description | No | Product description with HTML formatting support | |
| imageUrls | Yes | Product image urls | |
| instantDiscount | No | Product instant discount must be greater than 0. If instant discount amount is 0, the instant discount will be disabled. | |
| licenses | No | The list of licenses for your product | |
| name | Yes | Product name | |
| variantOptions | No | Product variant options | |
| variants | Yes | Product variants |
Output Schema
| Name | Required | Description |
|---|---|---|
| brand | No | Product brand |
| category | No | Category Object |
| code | No | Product code |
| description | No | Product description with HTML formatting support |
| giftGroups | No | Gift Groups of product |
| giftOption | No | Product Gift Option |
| hasOnlyDefaultVariant | No | If product doesn't have any variant will be returned 'true' |
| id | No | Identifying number of product |
| imageUrls | No | Product image urls |
| instantDiscount | No | If product doesn't have instant discount will be returned '0' otherwise returned with number |
| isDisplay | No | If product is displaying on storefront will be returned 'true' |
| licenses | No | The list of licenses for your product |
| name | No | Product name |
| variantOptions | No | Product options such as size or color |
| variants | No | Product variants |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are present, so the description must carry the full burden. It only states 'API for product creation' without mentioning side effects, authentication, rate limits, or other behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence plus an HTML link, which is concise but lacks structure. It could be more informative without becoming verbose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex tool with 10 parameters and nested objects, the description is too minimal. It does not provide a high-level overview of what the tool does (e.g., creates a full product with variants) or mention the output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, so the description adds minimal extra value. The link for categoryId is a small addition, but overall it does not significantly enhance understanding beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'API for product creation', which clearly identifies the verb and resource. However, it does not differentiate from sibling tools like 'Create_product_variants', which could lead to confusion about scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives (e.g., updates via 'Update_product_detail'). The description lacks context on prerequisites or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Create_product_variantsC
An API for product variants creation.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Product id | |
| variantOptions | Yes | Product variant options for designating the variant | |
| variants | Yes | Product variant template |
Output Schema
| Name | Required | Description |
|---|---|---|
| brand | No | Product brand |
| category | No | Category Object |
| code | No | Product code |
| description | No | Product description with HTML formatting support |
| giftGroups | No | Gift Groups of product |
| giftOption | No | Product Gift Option |
| hasOnlyDefaultVariant | No | If product doesn't have any variant will be returned 'true' |
| id | No | Identifying number of product |
| imageUrls | No | Product image urls |
| instantDiscount | No | If product doesn't have instant discount will be returned '0' otherwise returned with number |
| isDisplay | No | If product is displaying on storefront will be returned 'true' |
| licenses | No | The list of licenses for your product |
| name | No | Product name |
| variantOptions | No | Product options such as size or color |
| variants | No | Product variants |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, and the description does not disclose behavioral traits such as whether the operation is destructive, authentication requirements, or side effects like inventory adjustments.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very short but fails to convey critical information. It is not front-loaded with the most important details, making it less helpful despite its brevity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of the input schema (nested objects, three required parameters), the description is too sparse. It does not reference the output schema or explain the relationship between 'variantOptions' and 'variants'.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage for all parameters, but the tool description itself adds no additional meaning or context beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'product variants creation', which matches the tool name and distinguishes from 'Create_product' and other sibling tools. However, it is generic and does not specify what constitutes a product variant or that it requires an existing product ID.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives like 'Create_product'. No prerequisites or conditions (e.g., product must exist) are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Decrease_inventoryB
API for updating inventory by decreasing the inventory amount from the current inventory on hand.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Inventory ID | |
| amount | Yes | Amount must greater than 0 and less than 100,000 (0 < amount <= availableNumber < 100,000) |
Output Schema
| Name | Required | Description |
|---|---|---|
| availableNumber | No | Quantity that is available and display on the storefront (Exclude ‘Reserved’ and ‘Ready to ship’ status) |
| onHandAmount | No | Quantity in stock (Include ‘Reserved’ and ‘Ready to ship’ status) |
| readyToShipAmount | No | Quantity that customers complete payment and wait to ship |
| reservedAmount | No | Quantity that customers do not complete payment |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Without annotations, the description carries the burden of disclosure. It implies a mutation operation but does not detail idempotency, error handling, or checks like insufficient inventory. The parameter constraint '0 < amount <= availableNumber' is embedded in schema description, adding some transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, efficient but slightly wordy (e.g., 'API for updating inventory'). It could be more direct. No structural issues.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has an output schema (not provided) and many similar sibling tools, the description lacks context for return values and does not help the agent distinguish when to use this tool over others like 'Adjust_inventory' or 'Increase_inventory'.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage with clear descriptions for both parameters. The overall description adds minimal value beyond that, only noting the operation decreases from current inventory. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool decreases inventory amount, specifying the verb and resource. However, it could better distinguish from siblings like 'Increase_inventory' or 'Adjust_inventory' by explicitly saying it reduces stock.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives. It does not mention the context for decreasing inventory, such as handling returns or manual adjustments, nor does it exclude scenarios better suited for other tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Delete_productC
An API for product deletion.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Product id |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry the burden of behavioral disclosure. It only states 'deletion' without indicating whether the operation is irreversible, requires permissions, or affects related data.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely short but lacks substance. It is essentially a tautology of the tool name, offering no additional value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simplicity (1 param, no output schema, no annotations), the description could still mention effects like permanence or cascading actions. It fails to provide complete context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 100% coverage with a clear description for the 'id' parameter. The description adds no additional meaning beyond the schema, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly identifies the tool as for product deletion, which is specific and distinguishes it from sibling tools like Delete_product_variant. However, it lacks further detail on the scope or behavior.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives such as adjusting inventory or cancelling orders. No prerequisites or usage context are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Delete_product_variantC
An API for product variant deletion.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Product id | |
| name | Yes | Name of product variant | |
| value | Yes | Value of product variant |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so the description carries full burden. It only says 'deletion' without disclosing permanence, cascading effects, or authorization needs. For a destructive action, more behavioral context is expected.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, which is concise but lacks structure. It does not include any additional context or formatting. It is functional but could benefit from more substance without being verbose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool is a deletion operation with no output schema and no annotations, the description should provide more context about the deletion's implications, error handling, or prerequisites. It only states the basic purpose, leaving gaps for the agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers 100% of parameters with descriptions and examples. The description adds no additional meaning beyond the schema, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool is for product variant deletion. It distinguishes from sibling tools like Create_product_variants and Update_product_variant_detail. However, it could be more specific about the identification logic (product id + variant name/value), which is clarified in the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use versus alternatives. There is no mention of prerequisites (e.g., variant must exist), nor exclusions or when not to use (e.g., if variant is in use). Sibling tools exist for creating and updating, but no comparative context is provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get_all_ordersC
An API for getting a list of orders by condition
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | For searching the 'customer name' or 'order number' that partial match the given keyword | |
| page | No | For pagination, page is the page number to query the list of orders | |
| perPage | No | For pagination, per page is the number of showing orders on a page | |
| sortBy | No | For sorting of results by specific field | |
| orderBy | No | To define whether results are sorted in ascending or descending order | |
| orderStatus | No | Filtered by multiple values of order status | |
| paymentStatus | No | Filtered by multiple values of payment status | |
| paymentMethod | No | Filtered by multiple values of payment method | |
| shipmentStatus | No | Filtered by multiple values of shipment status | |
| orderType | No | Filtered by multiple values of order type | |
| startAt | No | Filtered by starting point of updated time. Example value is '2022-01-01T09:30:00Z' | |
| endAt | No | Filtered by ending point of updated time. Example value is '2022-01-01T09:30:00Z' |
Output Schema
| Name | Required | Description |
|---|---|---|
| currentPage | No | Current page number |
| data | No | |
| perPage | No | Number of showing orders per page |
| totalPage | No | Total page numbers of the result |
| totalRow | No | Total number of orders |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fails to disclose any behavioral traits such as pagination behavior, result limits, or side effects. It only states the basic purpose, leaving the agent uninformed about important runtime characteristics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, which is concise, but it lacks structure and does not front-load the most critical information. It is minimal but not wasteful, earning a middle score.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has 12 parameters, no annotations, and an output schema (not shown), the description is insufficient. It does not mention pagination, sorting, default ordering, or what happens when no parameters are provided. The agent needs more context to use this tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, so all parameters are already documented in the schema. The description adds no additional meaning beyond 'by condition', which is already implied by the many filter parameters. Thus, the description does not enhance parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states it gets a list of orders by condition, which clearly indicates the tool's function of retrieving filtered order lists. However, it does not specify that the list supports pagination, sorting, and multiple filter parameters, which are evident from the schema but not mentioned in the description.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives like Order_detail (which retrieves a single order) or other list tools. The description lacks any context about prerequisites, typical use cases, or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Get_all_productsC
An API for getting a list of products
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Filtered by multiple values of product id | |
| skus | No | Filtered by multiple values of product sku | |
| page | No | For pagination, page is the page number to query the list of products | |
| perPage | No | For pagination, per page is the number of showing products on a page |
Output Schema
| Name | Required | Description |
|---|---|---|
| currentPage | No | Current page number |
| data | No | |
| perPage | No | Number of showing products per page |
| totalPage | No | Total page numbers of the result |
| totalRow | No | Total number of products |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It does not mention that the operation is read-only, nor does it describe pagination behavior or any side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, which is concise but too brief. It could include more useful information, so it is average in conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the four parameters and existence of an output schema, the description lacks details on pagination, filtering behavior, and return structure. It is incomplete for a tool with moderate complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already explains each parameter well. The description adds no extra meaning beyond the schema, so baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool retrieves a list of products, using a specific verb and resource. However, it lacks differentiation from sibling tools like 'Get_all_orders'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives. There are many sibling tools for creating, updating, or deleting products, but the description does not clarify that this is for fetching only.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Increase_inventoryB
API for updating inventory by increasing the inventory amount from the current inventory on hand.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Inventory ID | |
| amount | Yes | Amount must greater than 0 and less than 100,000 (0 < amount + availableNumber < 100,000) |
Output Schema
| Name | Required | Description |
|---|---|---|
| availableNumber | No | Quantity that is available and display on the storefront (Exclude ‘Reserved’ and ‘Ready to ship’ status) |
| onHandAmount | No | Quantity in stock (Include ‘Reserved’ and ‘Ready to ship’ status) |
| readyToShipAmount | No | Quantity that customers complete payment and wait to ship |
| reservedAmount | No | Quantity that customers do not complete payment |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so description carries full burden. It specifies the operation (increasing from current on hand) but does not disclose side effects, required permissions, idempotency, or error handling. Adequate but could be richer.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single sentence, to the point, no wasted words. Could be slightly more structured (e.g., bullet for parameters) but fine.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Low complexity tool with output schema (not provided but exists). Description lacks success/error behavior or return format. Adequate for simple operation but not fully self-contained.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with clear parameter descriptions and examples. The description adds marginal value by clarifying 'from the current inventory on hand', but this is minimally additive beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it increases inventory amount from current on hand, with specific verb 'increasing' and resource 'inventory'. This distinguishes it from sibling tools like 'Decrease_inventory' and 'Adjust_inventory'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives (e.g., 'Adjust_inventory', 'Decrease_inventory'). No when-not-to-use or prerequisite conditions provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Mark_as_paid_CODA
Update order status to Complete by Mark payment status as Paid to the selected order that payment method is COD
| Name | Required | Description | Default |
|---|---|---|---|
| orderNo | Yes | Order number |
Output Schema
| Name | Required | Description |
|---|---|---|
| checkoutAt | No | Checkouted date |
| discountAmount | No | Total discount from the order price (excluding instant discounts applied to products) |
| isGift | No | If product is set to 'Allow gift' or 'Gift only' will be returned 'true' |
| lastUpdatedAt | No | Last updated date |
| orderItems | No | |
| orderNumber | No | Order number |
| orderStatus | No | Order status |
| paidAt | No | Paid date |
| paymentMethod | No | Payment method |
| paymentStatus | No | Payment status |
| remarkBuyer | No | Note from buyer |
| remarkRecipient | No | Remark recipient |
| shipmentDetail | No | |
| shipmentPrice | No | Total shipping fee |
| shipmentStatus | No | Shipment status |
| shippingAddress | No | |
| subtotalPrice | No | Subtotal price after applying instant discount to order items |
| totalPrice | No | Total order price (subtotalPrice + shipmentPrice - discountAmount) |
| weight | No | Total weight |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It discloses that the tool changes payment status to Paid and order status to Complete, which is minimal behavioral info. It does not mention prerequisites (e.g., order must be COD), idempotency, or side effects for already paid orders.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, no redundant words. However, grammatical awkwardness ('by Mark payment status') slightly reduces clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return values need not be explained. But the description lacks context about prerequisites (e.g., order must be COD and not already paid) and error conditions. Somewhat incomplete for a mutation tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% (one parameter with description 'Order number'). The tool description ('selected order') adds no new meaning beyond the schema. Baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly specifies the action (update order status to Complete by marking payment as Paid) and the resource (selected COD orders). It effectively distinguishes from siblings like Mark_as_ship and Cancel_Order by focusing on COD payment method.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies that this tool is specifically for orders with COD payment method ('that payment method is COD'). While it does not explicitly state alternatives, the context is clear enough for an agent to infer when to use this tool versus others.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Mark_as_shipC
Update order status to Complete by Mark shipment status as shipped and add tracking number
| Name | Required | Description | Default |
|---|---|---|---|
| orderNo | Yes | Order number | |
| trackingNumber | No | ||
| trackingUrl | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| checkoutAt | No | Checkouted date |
| discountAmount | No | Total discount from the order price (excluding instant discounts applied to products) |
| isGift | No | If product is set to 'Allow gift' or 'Gift only' will be returned 'true' |
| lastUpdatedAt | No | Last updated date |
| orderItems | No | |
| orderNumber | No | Order number |
| orderStatus | No | Order status |
| paidAt | No | Paid date |
| paymentMethod | No | Payment method |
| paymentStatus | No | Payment status |
| remarkBuyer | No | Note from buyer |
| remarkRecipient | No | Remark recipient |
| shipmentDetail | No | |
| shipmentPrice | No | Total shipping fee |
| shipmentStatus | No | Shipment status |
| shippingAddress | No | |
| subtotalPrice | No | Subtotal price after applying instant discount to order items |
| totalPrice | No | Total order price (subtotalPrice + shipmentPrice - discountAmount) |
| weight | No | Total weight |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description bears full responsibility for behavioral disclosure. It states the action but omits any side effects, reversibility, error cases, or permission requirements. This is minimal for a status-changing tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, front-loading the primary action. It is concise with no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite having an output schema, the description lacks sufficient context for a tool with three parameters and sibling tools. It does not explain optionality of trackingNumber and trackingUrl, nor does it highlight any constraints. An agent may misinterpret required vs optional fields.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 33% (one of three parameters has a description). The description adds 'add tracking number' but does not clarify which parameter corresponds to that, nor does it explain trackingUrl's role or optionality. The meaning is not significantly enhanced beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool updates order status to Complete by marking shipment as shipped and adding a tracking number. It is specific about verb and resource, but does not explicitly distinguish from sibling tools like Update_tracking_number or Mark_as_paid_COD, which have similar scopes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool versus alternatives. There is no mention of prerequisites or exclusions, leaving the agent without context for selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Order_detailC
An API for getting an order detail
| Name | Required | Description | Default |
|---|---|---|---|
| orderNo | Yes | Order number |
Output Schema
| Name | Required | Description |
|---|---|---|
| checkoutAt | No | Checkouted date |
| discountAmount | No | Total discount from the order price (excluding instant discounts applied to products) |
| isGift | No | If product is set to 'Allow gift' or 'Gift only' will be returned 'true' |
| lastUpdatedAt | No | Last updated date |
| orderItems | No | |
| orderNumber | No | Order number |
| orderStatus | No | Order status |
| paidAt | No | Paid date |
| paymentMethod | No | Payment method |
| paymentStatus | No | Payment status |
| remarkBuyer | No | Note from buyer |
| remarkRecipient | No | Remark recipient |
| shipmentDetail | No | |
| shipmentPrice | No | Total shipping fee |
| shipmentStatus | No | Shipment status |
| shippingAddress | No | |
| subtotalPrice | No | Subtotal price after applying instant discount to order items |
| totalPrice | No | Total order price (subtotalPrice + shipmentPrice - discountAmount) |
| weight | No | Total weight |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must convey behavioral traits. It only states 'getting' which implies a read operation, but does not disclose permissions, rate limits, or response format. The description carries the full burden and is insufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very concise (6 words), but is under-specified. It is not padded with fluff, but the brevity reduces informativeness. An ideal concise description would be a bit more specific.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simplicity of the tool (1 parameter, output schema present), the description barely meets minimum completeness. It fails to explain what constitutes an 'order detail' or any constraints, relying entirely on the output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with a single parameter 'orderNo' described as 'Order number'. The description adds 'order detail' context but does not improve upon the schema's existing documentation. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description 'An API for getting an order detail' clearly states the verb (getting) and resource (order detail). It distinguishes from sibling tools like 'Get_all_orders' by implying a single-order query, but does not explicitly differentiate.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives such as 'Get_all_orders' or 'Settlement_detail'. No prerequisites or context for invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Print_parcel_labelC
An API for downloading parcel label.
| Name | Required | Description | Default |
|---|---|---|---|
| orderNo | Yes | Order number | |
| details | No | Parcel label additional detail. <br> Please see Parcel Label Request: <a href="#Adding-Parcel-Detail">Adding Parcel Detail</a> | |
| language | No | Language used on the parcel label | |
| option | Yes | Parcel label option. <br> Please see Parcel Label Request: <a href="#Parcel-Size-and-Option">Parcel Size and Option</a> | |
| size | Yes | Parcel label format |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must fully disclose behavior. It only says 'downloading parcel label', omitting details like API method (GET/POST), response format, error handling, or authorization needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, concise sentence that front-loads the purpose. However, it is so brief that it borders on under-specification.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite having an output schema and 100% schema coverage, the description lacks practical usage context: how to invoke (e.g., initiates download), dependencies (order must exist), and expected output format.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and parameters are well-documented with enums and descriptions. The tool description adds no extra parameter info, so baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool is for 'downloading parcel label', which is a specific verb+resource. It distinguishes itself from sibling tools like order management or inventory tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance is provided on when to use this tool, prerequisites (e.g., order must be shipped), or when not to use it. Agent has no context for proper invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Send_message_via_OA_Plus_flex_message_servicesC
Send message api is a proxy message services that receive message object and forward to flex message api
| Name | Required | Description | Default |
|---|---|---|---|
| orderNo | Yes | Order number | |
| messages | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| messageIds | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description mentions 'proxy' and 'forward', implying no storage of messages, but provides no details on side effects, authorization needs, rate limits, or error states. With no annotations, the description should disclose behavioral traits, but it falls short.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that conveys the core purpose without extraneous words. It is front-loaded and efficient, though minor rewording could improve clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has 2 required parameters and an output schema, the description does not mention return values or behavior on success/failure. It lacks completeness for an agent to use safely without additional context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 50% (only 'orderNo' has a description; 'messages' items have no schema). The description says 'receive message object' but does not explain the expected structure of the message array items, leaving the agent with insufficient guidance.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool sends a message via a proxy to a Flex Message API. It uses a specific verb ('send') and resource ('message via OA Plus flex message services'), and it is distinct from sibling tools that handle orders and products. However, the phrase 'proxy message services' and 'flex message api' are somewhat vague and could be more precise.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool compared to alternatives. It does not mention prerequisites, constraints, or when not to use it. Since there are no sibling messaging tools, missing guidance is less critical, but still absent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Settlement_detailC
An API for getting a settlement detail
| Name | Required | Description | Default |
|---|---|---|---|
| orderNo | Yes | Order number |
Output Schema
| Name | Required | Description |
|---|---|---|
| orderIncomeDetail | No | Order income detail |
| orderNumber | No | Order number |
| settlementDetail | No | Settlement detail |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the burden of behavioral disclosure. It only says 'getting,' implying a read operation, but does not mention safety, authentication, rate limits, or what happens if the order doesn't exist. More detail is needed for a reliable agent invocation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very short with no unnecessary words, but the phrase 'An API for' is filler. The core verb+object 'getting a settlement detail' is clear but could be more direct. Overall, it earns its place without being verbose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has a single parameter and an output schema (not shown), the description is adequate but lacks explanation of what a settlement detail is and when to use it. For a simple tool, it is minimally complete but could be improved with brief context on the returned data or purpose.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% for the single parameter orderNo, which is described as 'Order number.' The description adds no additional meaning beyond the schema, so baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'getting a settlement detail,' which is a specific verb and resource, but it is vague about what a 'settlement detail' entails. The connection to the order number parameter is implied but not explicit, leaving room for ambiguity. It does not distinguish itself well from sibling tools like Order_detail.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives. Sibling tools include Order_detail and others, but the description provides no context for when Settlement_detail is appropriate, such as for financial settlement data after an order is completed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Update_product_detailC
An API for product detail updating. For product Categories ID variable please find more information on Development guideline
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Product id | |
| brand | No | Product brand | |
| categoryId | No | Product category id | |
| code | No | Product code | |
| description | No | Product description with HTML formatting support | |
| imageUrls | No | Product image urls | |
| licenses | No | The list of licenses for your product. | |
| name | No | Product name | |
| variantOptions | No | Product variant options |
Output Schema
| Name | Required | Description |
|---|---|---|
| brand | No | Product brand |
| category | No | Category Object |
| code | No | Product code |
| description | No | Product description with HTML formatting support |
| giftGroups | No | Gift Groups of product |
| giftOption | No | Product Gift Option |
| hasOnlyDefaultVariant | No | If product doesn't have any variant will be returned 'true' |
| id | No | Identifying number of product |
| imageUrls | No | Product image urls |
| instantDiscount | No | If product doesn't have instant discount will be returned '0' otherwise returned with number |
| isDisplay | No | If product is displaying on storefront will be returned 'true' |
| licenses | No | The list of licenses for your product |
| name | No | Product name |
| variantOptions | No | Product options such as size or color |
| variants | No | Product variants |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavioral traits. It only says 'updating' without mentioning side effects, authorization, rate limits, or failure handling. The link for category ID is helpful but insufficient for a mutation tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is very short (two sentences), with no fluff. However, it could be more informative without adding length. Conciseness is good, but lacks depth.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity (9 parameters, nested objects, output schema exists), the description is too minimal. It does not explain prerequisites, overall effect, or how it differs from sibling tools. The output schema covers return values, but the description should provide more context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already describes all parameters. The description adds a link for the category ID parameter but does not provide further semantic value beyond the schema. Baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states it is for 'product detail updating,' which is clear about the verb and resource. However, it does not explicitly differentiate from sibling tools like Update_product_price or Update_product_variant_detail, though the name implies a broader scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description offers no guidance on when to use this tool versus alternatives. Given sibling tools for specific updates (price, variant, display status), the lack of context on when to choose this generic update tool is a gap.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Update_product_priceB
An API for updating prices and instant discounts on the product. (You can't edit product price and instant discount during the promotion period.)
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Product id | |
| instantDiscount | Yes | Product instant discount must be greater than 0. If instant discount amount is 0, the instant discount will be disabled. | |
| variants | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| brand | No | Product brand |
| category | No | Category Object |
| code | No | Product code |
| description | No | Product description with HTML formatting support |
| giftGroups | No | Gift Groups of product |
| giftOption | No | Product Gift Option |
| hasOnlyDefaultVariant | No | If product doesn't have any variant will be returned 'true' |
| id | No | Identifying number of product |
| imageUrls | No | Product image urls |
| instantDiscount | No | If product doesn't have instant discount will be returned '0' otherwise returned with number |
| isDisplay | No | If product is displaying on storefront will be returned 'true' |
| licenses | No | The list of licenses for your product |
| name | No | Product name |
| variantOptions | No | Product options such as size or color |
| variants | No | Product variants |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description carries full burden. It indicates mutation and a promotion-period limitation. Missing details on side effects, permissions, or what happens to existing discounts.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
One sentence with a parenthetical note, no wasted words. Efficient and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool updates both product-level discount and variant prices, but the description only mentions 'product' scope. No mention of output schema or variant handling. Some gaps remain.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 67%, and the description adds little beyond what the schema already provides. It restates the tool's purpose but does not clarify parameter interactions or constraints beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool updates prices and instant discounts on a product, and notes a constraint (cannot edit during promotions). However, it does not explicitly distinguish from sibling tools like Update_product_detail or Update_product_variant_detail.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives. Only a constraint on promotion periods is provided, but no context on prerequisites or when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Update_products_display_statusC
An API for product's display status updating.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Product id | |
| status | Yes | Product's display status |
Output Schema
| Name | Required | Description |
|---|---|---|
| brand | No | Product brand |
| category | No | Category Object |
| code | No | Product code |
| description | No | Product description with HTML formatting support |
| giftGroups | No | Gift Groups of product |
| giftOption | No | Product Gift Option |
| hasOnlyDefaultVariant | No | If product doesn't have any variant will be returned 'true' |
| id | No | Identifying number of product |
| imageUrls | No | Product image urls |
| instantDiscount | No | If product doesn't have instant discount will be returned '0' otherwise returned with number |
| isDisplay | No | If product is displaying on storefront will be returned 'true' |
| licenses | No | The list of licenses for your product |
| name | No | Product name |
| variantOptions | No | Product options such as size or color |
| variants | No | Product variants |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, and the description offers no behavioral details beyond 'updating'. It doesn't disclose side effects, prerequisites (e.g., product existence), or what happens to the current status.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, but it is grammatically awkward ('An API for product's display status updating'). It is concise but not well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite having an output schema, the description is too minimal for a mutation tool. It lacks context about immediate effects, error conditions, or integration with other processes like inventory or orders.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and both parameters (id, status with enum) are well-described in the schema. The description adds no new meaning beyond 'updating display status', so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool updates a product's display status. It uses a specific verb 'updating' and resource 'product's display status', distinguishing it from siblings like Update_product_detail or Update_product_price.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives. For example, it doesn't specify that this is appropriate when only the display status needs to change, not other product details.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Update_product_variant_detailC
An API for update specific variant detail for both with and without variant product.
| Name | Required | Description | Default |
|---|---|---|---|
| id__path | Yes | Product id (Path parameter) | |
| barcode | No | Product variant barcode. | |
| id | No | Product variant id. | |
| imageUrl | No | Product variant image URL. | |
| onHandNumber | No | Quantity in stock (Include ‘Reserved’ and ‘Ready to ship’ status). | |
| price | No | Product variant price. | |
| sku | No | Product variant sku. | |
| weight | No | Weight must be greater than or equal to 0.01 Kg, lower than or equal to 999.99 Kg and allow with two decimal place only. |
Output Schema
| Name | Required | Description |
|---|---|---|
| brand | No | Product brand |
| category | No | Category Object |
| code | No | Product code |
| description | No | Product description with HTML formatting support |
| giftGroups | No | Gift Groups of product |
| giftOption | No | Product Gift Option |
| hasOnlyDefaultVariant | No | If product doesn't have any variant will be returned 'true' |
| id | No | Identifying number of product |
| imageUrls | No | Product image urls |
| instantDiscount | No | If product doesn't have instant discount will be returned '0' otherwise returned with number |
| isDisplay | No | If product is displaying on storefront will be returned 'true' |
| licenses | No | The list of licenses for your product |
| name | No | Product name |
| variantOptions | No | Product options such as size or color |
| variants | No | Product variants |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must disclose behavior. It only says 'update' without clarifying if it's a partial or full update, permissions needed, or whether it affects products with/without variants consistently. No mention of side effects or idempotency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence, but it contains ambiguous phrasing ('both with and without variant product') that reduces clarity. It could be more concise and precise, but it's not overly long.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 8 parameters, sibling tools, and an output schema (though not shown), the description lacks context about the update behavior, response structure, and how it handles different product types. Incomplete for a mutation tool of this complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with detailed parameter descriptions. The description adds no additional meaning beyond what's in the schema, so baseline 3 is appropriate. It doesn't explain relationships or constraints beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states it updates variant detail, but it's vague: 'specific variant detail' and 'both with and without variant product' is unclear. It doesn't specify which fields can be updated, relying on schema. Compared to sibling tools like Update_product_detail, it distinguishes by targeting variants, but purpose is not sharply defined.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus alternatives like Update_product_detail, Create_product_variants, or Delete_product_variant. No context on prerequisites, limitations, or scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Update_tracking_numberB
Update the shipping tracking number for the selected order that the shipment status is Shipped.
| Name | Required | Description | Default |
|---|---|---|---|
| orderNo | Yes | Order number | |
| trackingNumber | No | ||
| trackingUrl | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| checkoutAt | No | Checkouted date |
| discountAmount | No | Total discount from the order price (excluding instant discounts applied to products) |
| isGift | No | If product is set to 'Allow gift' or 'Gift only' will be returned 'true' |
| lastUpdatedAt | No | Last updated date |
| orderItems | No | |
| orderNumber | No | Order number |
| orderStatus | No | Order status |
| paidAt | No | Paid date |
| paymentMethod | No | Payment method |
| paymentStatus | No | Payment status |
| remarkBuyer | No | Note from buyer |
| remarkRecipient | No | Remark recipient |
| shipmentDetail | No | |
| shipmentPrice | No | Total shipping fee |
| shipmentStatus | No | Shipment status |
| shippingAddress | No | |
| subtotalPrice | No | Subtotal price after applying instant discount to order items |
| totalPrice | No | Total order price (subtotalPrice + shipmentPrice - discountAmount) |
| weight | No | Total weight |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, so description must cover behavioral aspects. Only states a prerequisite (shipment status Shipped) and the update action. Does not disclose idempotency, error handling, authentication requirements, or side effects (e.g., overwriting previous tracking number).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single sentence that is front-loaded with verb and object. Efficient but could be structured for clarity (e.g., bullet points). No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Has output schema, so return values need not be explained. However, for a simple update tool, description should cover parameter usage, conditions, and potential errors. Only the prerequisite is mentioned. Missing details like required vs optional parameters beyond schema and what happens if order not found.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema has 3 parameters with 33% description coverage. Description adds the shipment status condition for orderNo context, but does not elaborate on trackingNumber or trackingUrl meaning, validation, or format beyond the examples. Does not compensate for low schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Describes specific action (update tracking number) for a specific resource (selected order) under a condition (shipment status is Shipped). Clearly distinguishes from sibling tools like Mark_as_ship or Cancel_Order.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
States when to use: only when shipment status is Shipped. Implicitly excludes use when status is not Shipped. Does not explicitly mention alternatives or when not to use, but context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.
22 tool updates
v0.1.0- First observed
Adjust_inventory - First observed
Cancel_Order - First observed
Create_checkout_link - First observed
Create_product - First observed
Create_product_variants - First observed
Decrease_inventory - First observed
Delete_product - First observed
Delete_product_variant - First observed
Get_all_orders - First observed
Get_all_products - First observed
Increase_inventory - First observed
Mark_as_paid_COD - First observed
Mark_as_ship - First observed
Order_detail - First observed
Print_parcel_label - First observed
Send_message_via_OA_Plus_flex_message_services - First observed
Settlement_detail - First observed
Update_product_detail - First observed
Update_product_price - First observed
Update_product_variant_detail - First observed
Update_products_display_status - First observed
Update_tracking_number
TDQS
Most tools target distinct resources and actions. However, Adjust_inventory overlaps with Increase_inventory and Decrease_inventory, as it also adjusts inventory by an amount, causing potential confusion. The order and product tools are well-separated.
Naming follows a mix of conventions: mostly verb_noun (e.g., Create_product), but some are noun_noun (Order_detail, Settlement_detail) or lengthy phrases (Send_message_via_OA_Plus_flex_message_services). Inconsistent use of 'Get' prefix (Get_all_orders vs Order_detail) adds to the inconsistency.
22 tools cover the major operations of a shopping API: product and variant CRUD, order management, inventory adjustments, checkout, messaging, and settlements. This is a well-scoped set for the domain without being overwhelming.
The tool surface covers core product and order workflows, but lacks inventory querying (no get_inventory), order creation (orders are presumably customer-initiated), and refund/return operations. Also missing category management, though categories are referenced in product tools.
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Related MCP Connectors
The Mercado Pago MCP Server implements the Model Context Protocol to provide AI agents and LLMs with access to Mercado Pago's APIs and tools within compatible development environments. It acts as an intermediary that translates Mercado Pago resources into executable functions (tools) that AI applications can invoke to perform actions and automate flows. The server simplifies integration, enables using documentation to implement or improve code, and optimizes operations through natural language interactions without manual implementations.
Model Context Protocol server for the Apideck Unified API. Connect any MCP-compatible agent framework to 100+ accounting systems, HRIS platforms, file storage providers, and more through one integration. More information https://www.apideck.com/mcp-server
MCP server for building and testing AI agents with multi-model experimentation and insights.
An MCP server that provides an API to LLMs to manage their JumpCloud resources.
Related MCP Servers
- AlicenseNot gradedqualityFmaintenanceModel Context Protocol server implementation that integrates the LINE Messaging API to connect AI agents with LINE Official Accounts, enabling agents to send messages to users.767Apache 2.0
- AlicenseAqualityDmaintenanceAI-powered MCP server for managing LINE Official Accounts. Send broadcasts, push messages, check analytics, manage rich menus — all through natural language via Claude, ChatGPT, or Cursor. 10 tools included: * Account info, friend count, message quota * Broadcast, push message, multicast * Delivery stats, user profiles, follower list * Rich menu management Supports 95M+ LINE users across Jap10MIT
- AlicenseAqualityBmaintenanceAn open-source MCP server that wraps the Shopline Open API into 143 AI-callable tools for e-commerce data analysis, enabling AI agents to query orders, products, inventory, customer behavior, and promotions from Shopline stores through natural language.10020MIT

LINE Bot MCP Serverofficial
AlicenseAqualityAmaintenanceMCP server that integrates the LINE Messaging API to enable AI agents to send messages and manage LINE Official Accounts.12767773Apache 2.0
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
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/woraphol-j/lineshopping-api-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server