Skip to main content
Glama

HelpCenter.io for agents

Scan a Knowledge Base to Import

helpcenter_scan_import
DestructiveIdempotent

Read a public Zendesk Guide, Intercom, Document360, Help Scout Docs, Front Knowledge Base or HelpDocs help center and answer what importing it would bring: its categories, articles and languages, and where each language lands here. Imports nothing yet.

The fastest way to fill the help center: scan, optionally choose with helpcenter_choose_import, run with helpcenter_run_import, follow with helpcenter_get_import. Every category and every language that can land here starts chosen.

The scan reads the remote help center, honouring its robots.txt, and the API gives it up to 40 seconds: longer than this call waits (25). If the call times out, the scan most likely carries on and saves its result: wait about 20 seconds and look for it with helpcenter_list_imports before scanning again, which would start it over. Scanning the same address again refreshes an import that has not run; scanning another address cancels an earlier one that never ran.

Refused for a source that needs signing in (needs_credentials): you cannot send a source's credentials, so file a migration request (helpcenter_request_migration) or ask the user to connect it from the dashboard. A platform the importer does not read comes back with importable: false; file a migration request for it.

Args:

  • url (string, required): the help center's address.

  • confirm_ownership (boolean, optional): true when the user owns that help center or may copy its content. Not needed while the help center is unclaimed; required once it is claimed.

Returns: { import: { id, platform, importable, status: "scanned", plan, selection, limit, ... } }. Keep the id.

Input Schema

NameRequiredDescriptionDefault
urlYesThe address of the help center to import: a public Zendesk Guide, Intercom, Document360, Help Scout Docs, Front Knowledge Base or HelpDocs help center (the scheme is optional).
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.
confirm_ownershipNotrue: the user owns this help center or may copy its content. Not needed while the help center is unclaimed; required once it has been claimed. Only send it when the user has said so.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Goes well beyond the annotations: discloses robots.txt compliance, the 40s server-side budget versus the 25s call wait, that a timed-out scan likely continues and can be found via helpcenter_list_imports, and the destructive-ish side effect that scanning a different address cancels a prior un-run import (consistent with destructiveHint=true). The only gap is that it does not state explicitly that the returned import/plan objects can be very large or what 'limit' means.

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 with purpose and the 'Imports nothing yet' caveat, then workflow, then failure modes, then args and return shape. Nearly every sentence carries operational value; slight density in the timeout paragraph keeps it from a 5.

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?

For a tool with real side effects, a long-running remote fetch, and no output schema, the description supplies the return shape sketch ({ import: { id, platform, importable, status, plan, ... } }) plus the instruction to keep the id. Timeout, credential-refusal, and unsupported-platform outcomes are all anticipated.

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 baseline is 3. The prose restates the confirm_ownership rule ('not needed while unclaimed; required once claimed') and the 'only send it when the user has said so' guard, but that is largely duplicated in the schema, and the description never mentions agent_key, which the schema covers thoroughly.

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 ('Read a public Zendesk Guide, Intercom, ... help center') and immediately bounds the output ('its categories, articles and languages, and where each language lands here'). The clarifying sentence 'Imports nothing yet' separates it decisively from helpcenter_run_import, which is its nearest sibling.

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?

Gives the full pipeline explicitly: scan, optionally helpcenter_choose_import, then helpcenter_run_import, then helpcenter_get_import. It also names the fallback for refused sources (helpcenter_request_migration) and the recovery path on timeout (wait ~20s, check helpcenter_list_imports rather than rescanning). When-to-use and when-not-to-use 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