HelpCenter.io

by io.helpcenter

Overview Discussions Admin

Get HelpCenter Image

helpcenter_get_image

Read-onlyIdempotent

Read one uploaded image by id: its public URL, type, size and checksum.

Read-only.

Args:

image_id (number, required).
response_format ('markdown' | 'json'): default 'markdown'.

Returns: { status: "success", image: { id, url, filename, mime_type, size, checksum, alt_text, snippets, created_at } }. alt_text is empty on a read; write your own into the .

Errors: 404 if the id is unknown, belongs to another help center, or is a picture from the editor's own library rather than an API upload.

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": {
      "image_id": "<image_id>"
    },
    "name": "helpcenter_get_image"
  }
}

Input Schema

Name	Required	Description	Default
`site_id`	No	Which help center to act on: an id from helpcenter_list_sites. Needed when this connection reaches more than one help center; omit it when it reaches one. Applies to this call only — pass it on every call of a task, and ask the user which help center they mean if their request does not say.
`image_id`	Yes	Id of the image to read.
`response_format`	No	Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload.	markdown

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 4, 2026

TDQS

A3.7/5.0

Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and open-world, so the safety profile is covered. The description adds genuinely non-obvious behavior: alt_text is always empty on a read and the caller must supply it when embedding via <img>, plus the exact 404 semantics distinguishing unknown ids, cross-help-center ids, and editor-library images.

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-loaded one-line purpose, then compact Args/Returns/Errors sections that are easy to scan. The Args block largely duplicates the schema and site_id is missing from it, but no sentence is filler and the return shape and error line both carry real information.

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

Completeness4/5

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

With no output schema, the description must and does spell out the response envelope and field list, and it documents the error path. The only meaningful gap is the absent site_id guidance for connections spanning multiple help centers, which the schema covers but the description does not reinforce.

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%, so the schema already documents image_id, response_format and the site_id multi-help-center rule, making 3 the baseline. The description repeats image_id and response_format without adding syntax or format detail, and notably omits site_id from its Args list even though that is the parameter with the most consequential semantics.

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 opening sentence gives a specific verb and resource ('Read one uploaded image by id') plus the returned fields (URL, type, size, checksum), which is far more than a restatement of the name. It implicitly separates itself from helpcenter_list_images by scoping to a single id, but never names that sibling or helpcenter_delete_image/upload_image as alternatives.

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

Usage Guidelines3/5

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

There is no explicit when-to-use or when-not-to-use guidance versus list_images or upload_image. What is present is indirect guidance: the 404 clause revealing that editor-library pictures and other help centers' images are out of scope narrows the domain usefully, but the agent must infer the routing decision.

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

All HelpCenter.io tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?