Skip to main content
Glama

list_integrations_by_key

Retrieve company integrations by specifying a service key such as Shopify, QuickBooks, or UPS. Use this tool to access integration details for subscription billing operations in e-commerce platforms.

Instructions

List company integrations by key name. GET /integrations/{keyName}/list. keyName: avalara, bigcommerce, customRate, fedex, flatRate, freeShipping, freshBooksCloudAccounting, google, mailchimp, monsoonStoneEdge, myob, pickupInStore, quickbooks, saasu, salesforce, shipBy, shipperHq, shippingZone, shopify, slack, smtp, taxamo, thomsonreuters, ups, upsShippingProtection, usps, vertex, xero.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNameYesIntegration key name (required). One of: avalara, bigcommerce, customRate, fedex, flatRate, freeShipping, freshBooksCloudAccounting, google, mailchimp, monsoonStoneEdge, myob, pickupInStore, quickbooks, saasu, salesforce, shipBy, shipperHq, shippingZone, shopify, slack, smtp, taxamo, thomsonreuters, ups, upsShippingProtection, usps, vertex, xero
Behavior2/5

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

With no annotations provided, the description carries full burden but offers minimal behavioral insight. It mentions the HTTP method (GET) which implies read-only behavior, but doesn't disclose pagination, rate limits, authentication requirements, error conditions, or what 'list' actually returns (e.g., array of integration objects). For a list operation with zero annotation coverage, this leaves significant gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is brief but inefficiently structured. The first sentence clearly states the purpose, but the second sentence mixes HTTP endpoint information with a redundant parameter value list that belongs in the schema. While not verbose, it includes technical details (GET endpoint) that don't enhance agent understanding and duplicates schema content.

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

Completeness2/5

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

For a list operation with no annotations and no output schema, the description is insufficient. It doesn't explain what constitutes an 'integration' in this context, what fields are returned, whether results are paginated, or how the list is formatted. The agent knows what to filter by but not what to expect in return.

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%, with the parameter 'keyName' fully documented in the schema including all valid values. The description repeats the parameter name and enumerates the same values, adding no meaningful semantics beyond what the schema already provides. This meets the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('List') and resource ('company integrations by key name'), making the purpose immediately understandable. It distinguishes itself from the sibling 'list_integrations' by specifying filtering by key name, though it doesn't explicitly contrast with 'get_integration_by_key' which appears to retrieve a single integration.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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 doesn't mention when to choose this over 'list_integrations' (which likely lists all integrations without filtering) or 'get_integration_by_key' (which likely retrieves details for a specific integration). The agent must infer usage from naming patterns alone.

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/rhinosaas/rebillia-mcp-server'

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