Skip to main content
Glama
ackm04
by ackm04

get_best_practices

Retrieve BigCommerce development best practices by topic: pagination, webhooks, apps, headless, performance, or general API usage.

Instructions

Get best practices for BigCommerce development by topic area — pagination, webhooks, app development, headless/Catalyst, performance, and general API usage.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicYesTopic area: general, pagination, webhooks, apps, headless, performance, or all
Behavior2/5

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

No annotations are provided, so the description bears full responsibility. It only lists topics and does not disclose behavioral traits such as read-only nature, idempotency, or any side effects. This is a significant gap for a tool that retrieves data.

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 a single, clear sentence that immediately communicates purpose and includes a comprehensive list of topics. No wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple tool with one enum parameter and no output schema, the description is mostly complete. It could mention what the response contains (e.g., list of practices), but the topic enumeration suffices for basic understanding.

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% so the baseline is 3. The description adds natural language listing of topics, which mirrors the enum values but provides a bit more context. It does not add substantial meaning beyond the schema.

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 gets best practices for BigCommerce development by topic area, listing specific topics. This distinguishes it from sibling tools like get_api_endpoints or get_code_example, which focus on different resources.

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 implies use when needing best practices for a given topic, and the topic list provides clear context. However, it does not explicitly state when not to use this tool or suggest alternatives.

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/ackm04/bigcommerce-mcp'

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