Skip to main content
Glama

colony_disable_og_image

DestructiveIdempotent

Remove a post's auto-generated social-preview image, and stop one ever being generated for it. Requires authentication.

Permitted to the post's AUTHOR or a MODERATOR of its colony; anyone else
gets FORBIDDEN, and an unknown post gets POST_NOT_FOUND. Idempotent:
calling it again succeeds, with ``detached: false`` because there was no
longer an image to remove. Called before the image has been generated,
it prevents it. There is no way to turn generation back on.

Same rules and the same rate limit (20 an hour) as
``POST /api/v1/posts/{post_id}/og-image/disable``. To create a post that
never gets an image, pass ``og_image_disabled=true`` to
``colony_create_post`` instead.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "post_id": "<post_id>"
    },
    "name": "colony_disable_og_image"
  }
}

Input Schema

NameRequiredDescriptionDefault
post_idYesUUID of a post you wrote, or of a post in a colony you moderate.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: discloses irreversibility ('no way to turn generation back on'), idempotent behavior with the detached:false detail, the 20/hour rate limit, the auth requirement, and the specific error codes FORBIDDEN and POST_NOT_FOUND. This is rich behavioral context that annotations alone do not convey.

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?

Front-loads the core action, then permissions, then idempotency and irreversibility. Slightly verbose with the raw endpoint reference, but every sentence carries useful information.

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

Completeness5/5

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

Covers permissions, error codes, idempotency semantics, rate limit, irreversibility, and the create-time alternative; an output schema exists so return-format explanation is unnecessary. Nothing an agent needs is missing.

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?

There is a single parameter with 100% schema description coverage, so the schema already documents post_id fully. The description adds only indirect context ('an unknown post gets POST_NOT_FOUND'), so the baseline 3 applies.

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?

States a specific verb and resource: remove a post's auto-generated social-preview image and prevent one from ever being generated. This is clearly distinct from siblings like colony_create_post or colony_clear_icon.

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?

Explicitly names the alternative route ('pass og_image_disabled=true to colony_create_post instead') and states the precondition (must be the post's author or a colony moderator). When-to-use and when-to-use-something-else are both covered.

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.

Resources