Skip to main content
Glama
ultimaps

@ultimaps/mcp

by ultimaps
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Render map

render_map
Read-only

Render maps of world, continents, countries, states, or ZIP areas as images, with choropleth, categorical, or custom region coloring, location pins, and legends.

Instructions

Render a map of the world, a continent, a country, its states/provinces/counties, or US ZIP code areas as an image shown in the conversation. Color regions with ONE of these (choropleth and categories are mutually exclusive):

  • choropleth: a number per region, e.g. {"values": {"California": 39.5, "Texas": 30.5}}. Classes, breaks and palette are picked from the data unless you set them.

  • categories: a label per region, e.g. {"values": {"France": "Euro", "Poland": "Złoty"}}. Colors are assigned automatically unless you set colors.

  • regions: explicit hex colors, e.g. {"Texas": "#1D4ED8"}. Also works on top of either mode as an override. Region keys can be names, ISO/FIPS-style codes or common aliases. Typos are auto-corrected, and every correction or unmatched key is reported with suggestions, so there is no need to call get_map_regions first. Get mapId from list_maps if you don't know it. Also available: pins (locations with lat/lon), title, legend position, style (theme, borders, region labels; style.labels.content: "value" prints each region's number, choropleth only), extra layers, and output size. dryRun: true validates and previews region matching and the color plan without rendering. Without an API key: 30 renders per hour and 5 per minute (dry runs count), PNG up to 1600 px wide, with Ultimaps attribution on the image. The default 1200 px width is right for viewing in chat. Larger widths and scales are for files and are saved to disk instead of shown. Formats: png, or svg with a Pro key. PDF is not available. Every render is also written to a file and the path reported. Relay that path: in a terminal client the inline image is visible to you but NOT to the user, and the file is the only thing they can open. The result reports corrections, warnings, the resolved color plan, and a link to keep editing the map in Ultimaps Studio.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
mapIdYesMap id from list_maps, e.g. `world`, `united-states`, `europe`, `united-states-california`. It is the map's slug on ultimaps.com (the last path segment, not the whole URL) and always resolves to the current edition.
styleNo
titleNo
dryRunNoValidate and preview without rendering: returns the region matching report, the resolved choropleth plan and a legend preview. No image and no monthly quota for keyed calls, but it still counts against the rate limit (one of the 30 keyless renders per hour).
layersNoExtra geographic layers to draw, e.g. {"cities": true, "roads": true}. Each map ships a subset (`layers` in list_maps and get_map_regions). Turning on a layer the map lacks is not an error: it is skipped with a `layer_unavailable` warning. Omitted layers are off, except layers a map turns on by default (currently `admin0` on ZIP-code maps); pass false to hide those.
legendNo
outputNoImage size and format. Keep the default width (1200 px) for images viewed in the conversation: much larger renders, and any scale of 2 or more, are too big to show inline and are saved to a file instead. Without an API key: width up to 1600 px, an explicit height up to 1600 px, scale 1. Hard caps: width×scale and height×scale ≤ 8192, and at most 4096×4096 pixels in total.
regionsNoOverride layer. Region key to hex color, applied AFTER choropleth/categories coloring and winning over it. Precedence: choropleth/categories paint first, `regions` overrides win, and everything else gets `choropleth.noDataColor` (choropleth mode), else `style.defaultRegionColor`, else the theme default.
locationsNoPin markers. They compose with every mode.
categoriesNoCategorical coloring mode. Mutually exclusive with `choropleth`. Unmatched keys simply leave their regions uncolored. The no-data fill is `style.defaultRegionColor`, and `noDataColor` does not apply here.
choroplethNoNumeric choropleth mode. Mutually exclusive with `categories` (one scale per map). `regions` composes with it as an override layer. If none of the keys in `values` match, the request fails even under `onUnmatched: warn`, since there is nothing to build a scale from. `type`, `classes`, `method` and `palette` are all optional: whatever you leave out is suggested from the data, and the resolved plan is reported in the result.
onUnmatchedNowarn = render anyway (unmatched regions get the no-data fill) and report. error = 400 with per-key suggestions. Recommended for production pipelines: error. Exception: in choropleth mode, ZERO matched keys is a 400 even under warn. warn

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileNoSet when the image was saved to disk (too large to inline, or SVG).
dryRunYes
formatNoImage format; absent on dry runs.
legendNoDry runs: legend preview, [{label, color}] or {points, stops} for a gradient.
editUrlNoOpens this map in Ultimaps Studio for editing or export.
embedUrlNoKeyless GET image URL, when the render is shareable that way.
renderIdYesThe API render id; quote it to Ultimaps support.
warningsYes
choroplethNoThe resolved choropleth plan. Dry runs add `reason` and `breaks`.
regionMatchingYes
keylessRemainingNoKeyless renders left in the current hour.
matchingTruncatedYesTrue when `corrected`/`unmatched` list only the first 5 of their counts. Repeat the call with dryRun: true for the full report.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations only include readOnlyHint and openWorldHint, so the description carries substantial behavioral disclosure. It reveals that renders count against rate limits, that outputs are written to files and the path must be relayed (critical for user visibility), and that dryRun validates without rendering. It also mentions the result reports corrections, warnings, and a Studio link. While detailed, it stops short of specifying exact API limits beyond the keyless tier, and the openWorldHint is only implicitly reflected in 'additive-only enums' statements. Overall it adds significant context 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.

Conciseness4/5

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

The description is well-structured with clear sections for coloring modes, additional options, and limits, and it front-loads the core functionality. It is longer than a typical description but packs valuable info like rate limits and file relay instructions. However, some repetition exists (e.g., width/scale caveats appear in both prose and output schema), and the sheer length may reduce scannability. Still, every sentence contributes to agent success, so a 4 is appropriate.

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 complex tool with 12 parameters, an output schema exists and extensively documents nested fields, so the description doesn't need to repeat those. It covers essential runtime behavior: rate limits, file output and relay requirement, dryRun validation, and result contents. It also includes tips like the default width being suitable for chat and SVG requiring Pro. The only minor gap is that it doesn't enumerate all possible layers, but the schema and sibling get_map_regions cover that. Given the complexity, it is remarkably complete.

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 schema description coverage is 75%, and the description compensates by summarizing key parameters like choropleth, categories, regions, style, legend, output, and dryRun with examples. It explains relationships (mutual exclusivity, precedence) and provides critical hints like the default 1200px width and file-saving behaviors for large renders. However, many nested parameters are exhaustively documented in the schema, so the description adds high-level guidance rather than per-field details, which is justified given the schema richness. It earns a 4 for good balance.

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 tool renders maps at multiple levels (world, continent, country, etc.) as an image shown in the conversation, and it distinguishes the main coloring modes (choropleth vs categories vs regions). It differentiates from siblings by referencing list_maps for getting mapId and get_map_regions for region lists, but these are complementary rather than alternatives. The purpose is unambiguous and specific.

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?

The description provides explicit guidance on when to use this tool and how to avoid unnecessary calls: it states that region typo auto-correction means there is no need to call get_map_regions first, and it directs to list_maps when mapId is unknown. It also clarifies mutual exclusivity of choropleth/categories and provides usage examples. This fully satisfies the 'when to use vs alternatives' criterion.

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

Deploy Server

Other Tools