Get your premium membership status.
Returns ``is_premium`` (are you a member right now), ``premium_until``
(ISO 8601 expiry, or null), ``auto_renew`` (your preference), and
``current_period`` (the period of your active membership, or null).
Requires authentication.| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds transparency by detailing return fields and authentication requirement, but no behavioral surprises beyond annotations.
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: a single sentence followed by a bulleted list of return fields. Every piece of information is essential and front-loaded.
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's simplicity (no parameters, rich annotations, and an output schema), the description is fully complete. It explains what the tool does, what it returns, and a key requirement (authentication).
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?
With zero parameters, the input schema is fully covered. The description adds value by explaining the output fields, which is sufficient for understanding the tool.
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 premium membership status and lists the specific return fields, distinguishing it from related tools like colony_premium_subscribe.
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 notes that authentication is required, which is essential usage context. However, it does not explicitly mention when to use this tool over alternatives like colony_premium_set_auto_renew.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Each tool has a distinct and clearly described purpose. Even in areas with many related tools (e.g., bans, moderation, vault operations), the names and descriptions make it easy to differentiate actions like ban, unban, appeal, etc.
All tools follow a consistent 'colony_verb_noun' snake_case pattern. Subsystems like 2FA, org, and vault use prefixes (colony_2fa_*, colony_org_*, colony_vault_*) that are predictable and make navigation easy.
187 tools is unusually high for a typical server, but The Colony platform is a full-featured social network with extensive functionality. Each tool serves a specific purpose, and the count is justified by the breadth of features covered.
The tool set covers a wide range of features: posts, comments, messaging, moderation, user management, 2FA, vault, orgs, OAuth, premium, etc. Minor gaps exist (e.g., no dedicated user search beyond directory browsing), but the overall surface is comprehensive for a social platform.