Skip to main content
Glama

Create word cloud job

create_word_cloud_job

Start a word cloud rendering job and get status and artifact URLs immediately, without waiting for completion. Enables asynchronous generation of styled word clouds from text or weighted words.

Instructions

Start a ShapeWords render job and return status/artifact URLs without waiting for completion.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
seedNoUnsigned 32-bit layout seed for reproducible browserless ShapeWords renders. Canvas-profile default: 0. Use engine auto or browserless; browser fallback does not support non-zero seed.
textNoWords, phrases, notes, or source text for the word cloud. Optional when words[] is provided.
widthNoCanvas width in pixels. Canvas-profile default: 800.
wordsNoExplicit weighted words. Use this when another system already tokenized, lemmatized, or scored the input.
engineNoHosted renderer engine. auto uses the hosted renderer default path.
formatNoOutput artifact format. Canvas-profile default: svg.
heightNoCanvas height in pixels. Canvas-profile default: 600.
localeNoShapeWords UI/render locale. Canvas-profile default: en.
paddingNoWord collision padding in pixels. Canvas-profile default: 3.
paletteNo
qualityNosq is faster, hq renders at higher device scale. Canvas-profile default: hq.
fillModeNoShape filling strategy. Canvas-profile default: fill.
maxWordsNoMaximum number of words to lay out. Canvas-profile default: 700.
colorModeNo
rotationsNoExplicit rotation angles in degrees. When provided, these override rotationPreset.
shapeTypeNoShapeWords shape id, for example circle, rectangle, heart, star, cloud, diamond, custom. Canvas-profile default: cloud.
backgroundNoOutput background style. Canvas-profile default: white.
fontFamilyNoShapeWords font family name. Canvas-profile default: Montserrat.
spiralTypeNoPlacement spiral algorithm. Canvas-profile default: archimedean.
maxFontSizeNo
minFontSizeNo
returnLayoutNoInclude layout JSON when supported. Canvas-profile default: false.
renderProfileNoDefault option profile. canvas matches the main ShapeWords canvas; api keeps the older compact Render API defaults.canvas
rotationPresetNoRotation preset matching the ShapeWords canvas. Canvas-profile default: orthogonal.
customShapeDefinitionNoCustom SVG shape definition used when shapeType is custom.
Behavior4/5

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

Annotations already indicate this is not read-only and not destructive, so the description need not repeat that. The description adds valuable behavior: that it starts a job and returns status/artifact URLs immediately, implying asynchronous execution. This goes beyond annotation hints and clarifies the tool's execution model.

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 a single, front-loaded sentence containing exactly the essential information: starts a job and returns URLs without waiting. No fluff or repetition.

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 tool has 25 parameters and no output schema, the description provides a high-level summary of the return (status/artifact URLs) and the async nature. It lacks details about job tracking or polling, but those are covered by sibling tools. The description is complete enough for an agent to select and invoke the tool 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?

Schema description coverage is 84%, so parameters are well-documented in the schema. The description adds no parameter-specific details, but the schema carries the burden. Baseline 3 is appropriate because the description doesn't compensate beyond the schema, but the schema does a sufficient job.

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 uses a specific verb 'Start' with resource 'ShapeWords render job', clearly indicating an asynchronous job creation. It distinguishes from siblings by noting 'without waiting for completion', which contrasts with render_word_cloud's likely synchronous behavior.

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?

The phrase 'without waiting for completion' clearly implies a background/async use case, distinguishing this from synchronous rendering. It doesn't explicitly name alternatives like render_word_cloud or get_word_cloud_job, but the context is clear and no exclusions are needed.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kirrrr-2423/shapewords-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server