Skip to main content
Glama

Export a Markdown Document

start_article_export
Read-only

Start an asynchronous export of the current saved document. Accepts natural workspace names and document titles; internal routing identifiers are optional. Pass the returned opaque jobId to get_article_export_status until the export completes. Use the identifier internally for polling and never show it to the user.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatYes
articleIdNoInternal document identifier when already available. Omit it when the user referred to the document by title.
workspaceIdNoInternal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace.
articleTitleNoHuman-visible document title. Prefer this over asking the user for an internal document identifier.
workspaceNameNoHuman-visible workspace name. Prefer this over asking the user for an internal workspace identifier.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
jobIdYesOpaque export handle required by get_article_export_status. Use it for polling, but never show it to the user.
formatYes
statusYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A3.6/5.0
Behavior1/5

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

The description contradicts the annotations. Annotations declare readOnlyHint=true, implying the operation does not modify state, but the description says 'Start an asynchronous export' which launches a job and side effects (creating an export). This is a serious inconsistency that could mislead an agent into assuming no side effects. Beyond the contradiction, the description adds some useful behavioral context (opaque jobId, don't expose to user) but fails to disclose any permission or rate-limit requirements, and the contradiction dominates.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, front-loaded with the core action ('Start an asynchronous export'), and packs essential operational details (jobId polling, internal vs natural names, don't expose jobId) without waste. Every sentence adds necessary information for correct invocation.

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?

Given the asynchronous nature, the description covers the key interaction pattern (poll with jobId) and the privacy requirement (don't show jobId). The output schema presumably documents the jobId return, so its absence here is acceptable. However, it omits any mention of errors or prerequisites (e.g., document must be saved), and does not address concurrency or rate limits. The schema covers format options, so completeness is reasonably high, but not exhaustive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description adds meaning beyond the schema by stating that natural workspace names and document titles are accepted and that internal routing identifiers are optional. This clarifies the dual-identification approach and reinforces which parameters to prefer, going beyond the schema's descriptive comments. With 80% schema coverage, the baseline is 3, but the description's explicit guidance on when to use which identifier adds value.

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?

The description clearly states the action (start an asynchronous export) and the resource (current saved document). It also distinguishes itself by noting the asynchronous nature and the presence of a jobId for polling, which is not mentioned in sibling tools like convert_document or render_article. The purpose is specific and unambiguous.

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?

The description provides clear guidance on how to use the tool after invocation: pass the jobId to get_article_export_status and never show jobId to the user. It also hints at parameter selection by mentioning natural workspace names and document titles are accepted. However, it does not explicitly state when to prefer this over alternatives like convert_document or render_article, leaving the when-to-use versus siblings implicit.

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.

TDQS

A3.6/5.0
Disambiguation4/5

Most tools have clearly distinct purposes across article CRUD, review workflows, publishing, and conversion/export. Minor confusion can arise between convert_document and start_article_export (and their corresponding status checkers), but the descriptions explicitly differentiate arbitrary content conversion from exporting stored documents. The render_article tool's broad contextual wording overlaps conceptually with several actions, though its actual function (opening the reader) is unique.

Naming Consistency5/5

All 22 tool names follow a strict snake_case verb_noun pattern, such as list_articles, accept_suggestion, start_article_export, and unpublish_article. There are no mixed conventions, vague verbs, or camelCase outliers, making the naming highly predictable.

Tool Count3/5

At 22 tools, the server sits above the ideal 3-15 range and feels somewhat heavy for an MCP surface. The inclusion of record_article_app_event, a component-only telemetry tool with no agent-facing value, adds to this heaviness. However, the breadth of the domain—documents, collaboration, publishing, and conversion—largely justifies the count.

Completeness3/5

The tool surface covers article lifecycle, review threads, publishing, export/conversion, and presence well, covering most common workflows. A notable gap is the lack of any delete_article or trash operation, leaving no way to remove documents. Additionally, updates are limited to anchored edits via edit_article, with no direct full-content replacement option.

Resources