Skip to main content
Glama

Retrieve Or Create Business Referral Code

retrieve_or_create_community_referral_code

Retrieve or create the referral code for a managed community. Business and community refer to the same thing and are interchangeable. Before offering this action or requesting its inputs, check business permissions. FREE businesses cannot use this tool, regardless of individual feature rows. Call check_business_tool_access before collecting inputs. Show any grace-period warning and verified resubscribe link before continuing, and never proceed when access is blocked.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
communityIdYes

TDQS

A4.3/5.0
Behavior5/5

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

Annotations provide readOnlyHint=false and destructiveHint=false, but description adds important behavioral context: it either retrieves or creates (non-destructive, non-read-only), requires authorization checks, and has business type restrictions. No contradiction with annotations.

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

Conciseness4/5

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

Description is a single paragraph that front-loads the main purpose and then provides usage guidelines. While slightly lengthy, every sentence adds value. Could be more concise, but overall well-structured.

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

Completeness3/5

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

Description covers purpose and usage guidelines well, but lacks information about the return value (e.g., does it return the referral code string?) and any side effects of creation. With no output schema, this gap is notable. The referencing sibling 'get_referral_code_details' implies details are separate, but the tool's output is not clarified.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Only one parameter 'communityId' with 0% schema description coverage. The description does not elaborate on the parameter beyond its basic purpose, leaving the agent without format or validation hints. The parameter is simple, but the description fails to compensate for the lack of schema documentation.

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?

Description clearly states the verb (retrieve or create) and resource (referral code for a managed community). It clarifies that 'business' and 'community' are interchangeable, distinguishing it from siblings like 'retrieve_or_create_business_referral_code' and 'create_my_referral_code'.

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

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Description explicitly states when to use this tool: after checking business permissions, calling 'check_business_tool_access', and handling grace-period warnings. It also specifies that FREE businesses cannot use it, providing clear exclusions and prerequisites.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

B3/5.0
Disambiguation2/5

Many tools are semantically identical, distinguished only by 'business' vs 'community' prefixes, and descriptions explicitly state they are interchangeable. This creates ambiguity for agent selection. Examples include add_business_admins/add_community_admins and get_business/get_community.

Naming Consistency3/5

Tools generally follow a verb_noun pattern, but the inconsistent use of 'business' vs 'community' for the same entities breaks the pattern. While individual naming is clear, the overall set lacks uniformity.

Tool Count1/5

With 423 tools, the server is massively over-scoped. The high count is driven by redundant 'business' and 'community' variants and many niche operations. A more focused surface would be far more manageable.

Completeness4/5

The tool set covers a broad range of features including CRUD operations for multiple product types, analytics, payments, messaging, and integrations. Minor gaps exist (e.g., missing update for some entity types), but overall domain coverage is strong.

Resources