Skip to main content
Glama

Start a Yappy export job

create_export_job
Idempotent

Start an asynchronous export of a Yappy corpus — documentation, FAQ, or release history — as markdown or JSON. This creates a job on the Yappy API and returns its id; poll it with get_export_job until the status is completed, then read result.url. Use it when you want the whole corpus rather than a page at a time. It creates a job and nothing else: no user data is touched and nothing can be deleted.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoThe artifact format.markdown
resourceYesWhich corpus to export.
idempotency_keyNoYour own key, so a retry returns the same job instead of starting a second one.

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already mark readOnlyHint=false and destructiveHint=false, and the description adds meaningful behavior: the operation is asynchronous, returns a job id, must be polled until completed, and exposes result.url. It explicitly guarantees no user data is touched and nothing can be deleted. It could add failure or status details, but this is strong coverage beyond annotations.

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?

Four sentences, all high-signal: purpose, workflow, when-to-use, and safety. Front-loaded with the core action, then proceeds to actionable details without redundancy.

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?

With no output schema, the description supplies the needed contract: returns a job id, poll until completed, read result.url. Together with full parameter schema and use-case guidance, an agent has enough to call and process the result correctly.

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?

The schema already has 100% description coverage, including enums for resource and format and a clear idempotency_key description. The tool description repeats those values but does not add meaningful new semantics beyond mapping the async workflow to the parameters. 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?

Description starts with a specific verb-resource pair: 'Start an asynchronous export of a Yappy corpus', then enumerates the corpus types (documentation, FAQ, release history) and output formats (markdown, JSON). It also names the polling sibling get_export_job, which clearly distinguishes this job-creating tool from the read-oriented siblings.

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?

Provides an explicit use condition: 'Use it when you want the whole corpus rather than a page at a time', which implies not for single-page grabs. It also routes the agent to get_export_job for polling and clarifies the tool creates a job and nothing else, giving a clear boundary versus other data-access tools.

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

A4.4/5.0
Disambiguation5/5

Each tool targets a clearly distinct piece of information or action: compatibility checks, system requirements, pricing, features, FAQ, releases, and export jobs. Even the pair check_mac_compatibility and get_system_requirements is separated by one asking for a decision about a specific Mac and the other returning raw requirements.

Naming Consistency5/5

Tool names consistently follow a verb_noun pattern using get_, list_, create_, and check_. Singular nouns pair with single-item resources and plural nouns with collection endpoints, making the set predictable.

Tool Count5/5

Nine tools is well-scoped for a product information and export server. Each tool covers a meaningful part of the surface without redundancy or padding.

Completeness5/5

The tool set covers the full likely question space for the Yappy app: compatibility, requirements, pricing, features, FAQ, latest release, release history, and bulk corpus export. The async export pair provides a complete path to documentation content without leaving dead ends.

Resources