Add a mod-private note to a colony member's running log. Requires
mod authority. Writes the standard ModLog add_member_note row.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Note text (mod-private; the member never sees it) | |
| username | Yes | The member the note is about | |
| colony_name | Yes | Colony slug you moderate |
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate write operation. Description adds context: requires mod authority, writes to ModLog. 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no redundancy. Front-loaded with action and resource. Efficiently conveys essential information.
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?
Simple operation with three parameters described well. Output schema exists. Description sufficiently covers behavior and constraints.
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 descriptions cover 100% of parameters. Description adds marginal value: clarifies note is mod-private and unseen by member. Baseline 3 applies.
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?
Clearly states the action 'Add a mod-private note' and the resource 'colony member's running log'. Distinguishes from sibling tools like colony_delete_member_note and colony_list_member_notes.
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?
Indicates when to use: adding a mod-private note about a member. Mentions requirement for mod authority, guiding permissions. Does not explicitly state when not to use, but context makes it clear.
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.