Skip to main content
Glama

HelpCenter.io for agents

Run an Import

helpcenter_run_import
Destructive

Start an import now, with what is chosen, or run a finished or failed one again. The run reads the source in the background: follow it with helpcenter_get_import until status is completed or failed.

Running again updates the articles it brought before and never adds them twice; an article edited here since is kept as it is and flagged for review. While the help center is unclaimed, a run that would take it past its 500 articles is refused (limit_reached).

Args:

  • import_id (number, required)

Returns: { import } with status queued or running.

Input Schema

NameRequiredDescriptionDefault
agent_keyYesThe api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content.
import_idYesThe import's id, from helpcenter_scan_import or helpcenter_list_imports.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true, idempotentHint=false, and openWorldHint=true, but the description adds substantive context beyond them: execution is asynchronous/background, a re-run updates rather than duplicates prior articles, locally edited articles are preserved and flagged for review, and unclaimed help centers are capped at 500 articles. That last 'kept as it is and flagged' detail materially softens the destructive framing, which an agent could not derive from the annotations alone.

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?

The core semantics are front-loaded in two short prose sentences followed by an Args line and a Returns line, with no filler. Minor waste: the Args entry merely echoes a parameter the schema fully documents.

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?

There is no output schema, and the description compensates by stating the return shape ({ import } with status queued or running) plus the polling contract and the domain-level 500-article limit. For a two-parameter async mutation, nothing an agent needs in order to invoke it correctly 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?

Schema description coverage is 100% and the agent_key parameter already carries a thorough explanation in the schema, so the baseline applies. The description's Args block only restates import_id as 'number, required' and adds no semantic detail beyond the schema's 'from helpcenter_scan_import or helpcenter_list_imports' phrasing.

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 ('Start an import now') and additionally covers the re-run case ('run a finished or failed one again'), which separates it cleanly from helpcenter_choose_import, helpcenter_scan_import, and helpcenter_cancel_import in the sibling list.

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

Usage Guidelines4/5

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

Explicitly routes the agent to helpcenter_get_import for polling until status is completed or failed, and names the limit_reached refusal condition. It does not spell out the precondition sequence (scan_import -> choose_import -> run_import), so the agent must infer that from the sibling names, which keeps this below a 5.

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