Ultimaps

Official3 toolsLive

by ultimaps · TypeScript

Create choropleth, category and pin maps of countries, states, counties and ZIP codes as images.

com.ultimaps/mcp — MCP Server

This MCP server generates map images for administrative geographies. It supports creating choropleth maps, category maps, and pin maps. The geographic coverage includes countries, states, counties, and ZIP codes.

🛠️ Key Features

Create choropleth maps
Create category maps
Create pin maps
Output map images for countries, states, counties, and ZIP codes

🚀 Use Cases

Visualizing regional data as choropleths
Displaying category-based geographic information
Marking specific locations with pin maps across countries, states, counties, and ZIP codes

⚡ Developer Benefits

Provides a single workflow for producing multiple map types
Enables consistent image generation across common administrative levels

⚠️ Limitations

No additional capabilities, configuration options, tool count, or detailed interfaces are provided in the available server data.

Captured live from the server via tools/list.

list_maps

List the maps Ultimaps can render: the world, continents, countries subdivided into states, provinces, counties or departments, and US ZIP code areas. Each row is {id, title, regionType, layers, regionCount, labels}. `id` is the mapId for render_map and get_map_regions; it is the map's slug on ultimaps.com (the last path segment, not the whole URL) and always means the current edition. `regionCount` is how many region keys a complete dataset needs. `labels: false` means the map has no region labels, so `style.labels` does nothing there. `layers` are the ids render_map's `layers` can turn on. Pass `query` to search ids, titles, region types and categories (e.g. "counties", "germany", "africa"). Only call this when you don't know the id: common ids such as `world`, `united-states` and `europe` just work, and an unknown id usually comes back with the closest ids.

Parameters1

query

string

optional

Search map ids, titles, region types and categories, e.g. "counties", "germany", "africa". Omit to list every map.

Raw schema

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "maxLength": 100,
      "description": "Search map ids, titles, region types and categories, e.g. \"counties\", \"germany\", \"africa\". Omit to list every map."
    }
  },
  "additionalProperties": false
}

get_map_regions

Look up one map: title, regionType, regionCount, labels, layers, and its regions as {key, title}, 200 per page. You rarely need this before rendering. render_map accepts region names, codes and common aliases and auto-corrects typos, reporting what it matched. Use it to build a dataset covering every region of a map, to see how a map names its regions, or to resolve a key render_map could not match. `query` searches keys, titles and aliases, so no hits means the map really has no such region. Use `offset` for further pages.

Parameters3

mapId	string	required	Map id from list_maps, e.g. "united-states", "europe", "united-states-california".
query	string	optional	Search region keys, titles and aliases, e.g. "saint" or "US-TX". Omit to page through every region.
offset	integer	optional	Skip this many regions. Pages hold 200 regions; use the offset the previous result names.

Raw schema

{
  "type": "object",
  "properties": {
    "mapId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Map id from list_maps, e.g. \"united-states\", \"europe\", \"united-states-california\"."
    },
    "query": {
      "type": "string",
      "maxLength": 100,
      "description": "Search region keys, titles and aliases, e.g. \"saint\" or \"US-TX\". Omit to page through every region."
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "description": "Skip this many regions. Pages hold 200 regions; use the offset the previous result names."
    }
  },
  "required": [
    "mapId"
  ],
  "additionalProperties": false
}

render_map

Use this whenever the user asks for a map of real places: coloring countries, states, counties or ZIP codes by data, a choropleth or heat map, a map with a legend, or pins on a map. Prefer it to generating an image or plotting with code. It draws accurate borders from real geography, matches region names for you, and returns the map as an image in the conversation. Maps cover the world, continents, countries, their states, provinces and counties, and US ZIP code areas. 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 per conversation (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, and larger images are returned only as a link. Formats: png, or svg with a Pro key. PDF is not available. Every result includes an image link that works for 30 days. Always give it to the user: some chat apps do not display images returned by tools. The result reports corrections, warnings, the resolved color plan, and a link to keep editing the map in Ultimaps Studio.

Parameters12

mapId	string	required	Map 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.
choropleth	object	optional	Numeric 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.
categories	object	optional	Categorical 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.
regions	object	optional	Override 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.
legend	object	optional
title	object	optional
locations	array	optional	Pin markers. They compose with every mode.
style	object	optional
layers	object	optional	Extra 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.
output	object	optional	Image 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 returned as a link 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.
onUnmatched	string	optional	warn = 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.
dryRun	boolean	optional	Validate 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 anonymous renders per hour without a key).

Raw schema

{
  "type": "object",
  "properties": {
    "mapId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Map 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.",
      "examples": [
        "united-states"
      ]
    },
    "choropleth": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "values"
      ],
      "description": "Numeric 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.",
      "properties": {
        "values": {
          "type": "object",
          "additionalProperties": {
            "type": "number"
          },
          "minProperties": 1,
          "maxProperties": 5000,
          "description": "Region key to numeric value. Keys go through the matching rules described above. Two keys resolving to the same region count as two matched keys, and the later value wins.\n"
        },
        "type": {
          "type": "string",
          "enum": [
            "auto",
            "gradient",
            "steps",
            "groups"
          ],
          "default": "auto",
          "description": "Visualization type. `auto` picks from the data: ≤7 unique values → `groups` (discrete legend items), skewed distributions → `steps` (contiguous bar with break ticks), else `gradient` (continuous color scale). Explicit values pin the type. `gradient` and `steps` legends are horizontal-only: they render in a top/bottom band (default bottom), and a left/right `legend.position` is coerced to bottom with a warning. That rule depends on the data, so JSON Schema cannot express it and generated SDKs should not try to enforce it.\n"
        },
        "palette": {
          "type": "string",
          "enum": [
            "gnbu",
            "bugn",
            "bupu",
            "orrd",
            "pubu",
            "pubugn",
            "purd",
            "rdpu",
            "ylgn",
            "ylgnbu",
            "ylorbr",
            "ylorrd",
            "blues",
            "greens",
            "greys",
            "oranges",
            "purples",
            "reds",
            "rdbu",
            "brbg",
            "spectral",
            "piyg",
            "prgn",
            "puor",
            "rdgy",
            "rdylbu"
          ],
          "description": "ColorBrewer palette id (the server matches case-insensitively). Absent = suggested from the data: diverging when the values cross zero (rdbu when they sit symmetrically around zero, rdylgn when they do not), sequential blues otherwise. Note that `rdylgn` only comes back out. It is not in the enum above, and requesting it is a `400`. Sequential palettes suit one-directional data, and diverging palettes (rdbu, brbg, spectral, piyg, prgn, puor, rdgy, rdylbu) suit data around a midpoint.\n"
        },
        "classes": {
          "type": "integer",
          "minimum": 2,
          "maximum": 9,
          "description": "Number of classes. Absent = suggested from the data (5 base, more for skewed distributions). Explicit counts are honored exactly, capped only by the number of unique values. Tied values can still collapse duplicate quantile edges, and a constant dataset collapses to one class. `dryRun` returns the breaks and effective class count that will actually be drawn.\n"
        },
        "method": {
          "type": "string",
          "enum": [
            "quantile",
            "equalInterval",
            "jenks",
            "pretty"
          ],
          "description": "Break method. Absent = suggested from the data. quantile = equal number of regions per class, equalInterval = equal-width value intervals, jenks = natural breaks (minimal within-class variance), pretty = rounded human-readable edges. Additive-only enum: more methods may be added, none removed.\n"
        },
        "noDataColor": {
          "type": "string",
          "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
          "examples": [
            "#1D4ED8"
          ],
          "description": "Fill for regions absent from `values`. Choropleth mode only. Overrides `style.defaultRegionColor` when both are set.\n"
        },
        "format": {
          "type": "object",
          "additionalProperties": false,
          "description": "Number format for every choropleth surface: class labels, gradient ticks and value labels. Always pass an object, e.g. {\"preset\": \"compact\"}, never a bare string. Presets: `auto` (default, inferred from magnitude), `plain` (39,538,223), `compact` (39.5M), `percent` (the input is a FRACTION, so 0.42 prints as 42% and 0.423 as 42.3%, because the preset trims trailing zeros. An explicit {\"style\": \"percent\", \"decimals\": 1} keeps them and prints 42.0%. For data already in percent points use {\"suffix\": \"%\"}), `currency` ($39,538,223). Or combine options, e.g. {\"decimals\": 1, \"suffix\": \"M\"} or {\"style\": \"currency\", \"currency\": \"EUR\"}. {\"d3\": \"~s\"} is a raw d3-format escape hatch. The result echoes the resolved format.",
          "properties": {
            "preset": {
              "type": "string",
              "enum": [
                "auto",
                "plain",
                "compact",
                "percent",
                "currency"
              ],
              "description": "Alias for the bare-string preset form."
            },
            "style": {
              "type": "string",
              "enum": [
                "decimal",
                "percent",
                "currency"
              ],
              "default": "decimal",
              "description": "\"percent\" MULTIPLIES BY 100. The input is a fraction (0.42 prints as \"42%\"). Data already in percent points should use `suffix: \"%\"` instead.\n"
            },
            "currency": {
              "type": "string",
              "pattern": "^[A-Za-z]{3}$",
              "default": "USD",
              "description": "ISO-4217 code, rendered with its Intl symbol (\"€\", \"CA$\"). Only valid with style \"currency\".\n"
            },
            "compact": {
              "type": "boolean",
              "description": "Compact notation: K/M/B/T (never SI \"G\")."
            },
            "decimals": {
              "type": "integer",
              "minimum": 0,
              "maximum": 6,
              "description": "Fraction digits. Min equals max, for uniform labels, unless `trim` is set."
            },
            "significantDigits": {
              "type": "integer",
              "minimum": 1,
              "maximum": 6
            },
            "trim": {
              "type": "boolean",
              "description": "Strip trailing zeros."
            },
            "grouping": {
              "type": "boolean",
              "default": true,
              "description": "Thousands separators."
            },
            "sign": {
              "type": "string",
              "enum": [
                "auto",
                "always",
                "exceptZero"
              ],
              "default": "auto",
              "description": "Maps 1:1 to Intl signDisplay. \"exceptZero\" is the usual choice for diverging legends.\n"
            },
            "prefix": {
              "type": "string",
              "maxLength": 12,
              "description": "Literal, inserted AFTER any leading sign (\"-€1,234\", never \"€-1,234\").\n"
            },
            "suffix": {
              "type": "string",
              "maxLength": 20,
              "description": "Literal, e.g. \" per km²\"."
            },
            "d3": {
              "type": "string",
              "maxLength": 20,
              "description": "Escape hatch: a raw d3-format spec. Invalid grammar is a 400.\n"
            }
          }
        }
      }
    },
    "categories": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "values"
      ],
      "description": "Categorical 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.\n",
      "properties": {
        "values": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "minLength": 1
          },
          "minProperties": 1,
          "maxProperties": 5000,
          "description": "Region key to category name."
        },
        "colors": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
            "examples": [
              "#1D4ED8"
            ]
          },
          "description": "Optional category name to color. Names are matched exactly and case-sensitively against the names in `values` (unlike region keys, which are matched loosely). An entry for a category no region uses is silently ignored. Unlisted categories get a color from a built-in categorical palette, assigned in order of first appearance in `values`, so pin the colors if you need stable output.\n"
        }
      }
    },
    "regions": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
        "examples": [
          "#1D4ED8"
        ]
      },
      "maxProperties": 5000,
      "description": "Override 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.\n"
    },
    "legend": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "position": {
          "type": "string",
          "enum": [
            "left",
            "right",
            "top",
            "bottom"
          ],
          "description": "left/right take a column carved from the map area (180 px, at most 30% of the width); top/bottom take a horizontal band between the title and the map. Absent = left for item/group legends, bottom for gradient/steps. Gradient and steps legends are horizontal-only, so left/right becomes bottom with a warning. Legends do not wrap: a wide legend on a narrow image can overflow, reported as a `legend_overflow` warning."
        },
        "show": {
          "type": "boolean",
          "description": "Defaults to true whenever a legend exists (auto-generated for `choropleth`/`categories`, or from `legend.items`). Set false to suppress it and give the whole canvas to the map.\n"
        },
        "items": {
          "type": "array",
          "minItems": 1,
          "maxItems": 50,
          "description": "Manual legend items, for regions-only maps. With `choropleth` or `categories` the legend is auto-generated and `items` is rejected with 400.\n",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "label",
              "color"
            ],
            "properties": {
              "label": {
                "type": "string",
                "minLength": 1,
                "maxLength": 120
              },
              "color": {
                "type": "string",
                "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
                "examples": [
                  "#1D4ED8"
                ]
              }
            }
          }
        }
      }
    },
    "title": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "text"
      ],
      "properties": {
        "text": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "position": {
          "type": "string",
          "enum": [
            "top",
            "bottom"
          ],
          "default": "top"
        },
        "color": {
          "type": "string",
          "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
          "examples": [
            "#1D4ED8"
          ]
        }
      }
    },
    "locations": {
      "type": "array",
      "maxItems": 200,
      "description": "Pin markers. They compose with every mode.",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "title",
          "lat",
          "lon"
        ],
        "properties": {
          "title": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "lat": {
            "type": "number",
            "minimum": -90,
            "maximum": 90
          },
          "lon": {
            "type": "number",
            "minimum": -180,
            "maximum": 180
          },
          "color": {
            "type": "string",
            "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
            "examples": [
              "#1D4ED8"
            ]
          },
          "labelPosition": {
            "type": "string",
            "enum": [
              "top",
              "bottom",
              "left",
              "right"
            ],
            "default": "bottom",
            "description": "Where the pin's label sits relative to the pin."
          },
          "showLabel": {
            "type": "boolean",
            "default": true,
            "description": "Set false to render this pin without its label (the marker stays).\n"
          }
        }
      }
    },
    "style": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "theme": {
          "type": "string",
          "default": "paper",
          "enum": [
            "paper",
            "newspaper",
            "dark",
            "earth",
            "vintage",
            "embossed",
            "maritime",
            "neon",
            "outline",
            "wireframe"
          ],
          "description": "Theme name from Studio's theme gallery (the server matches case-insensitively). Additive-only enum.\n"
        },
        "backgroundColor": {
          "type": "string",
          "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
          "examples": [
            "#1D4ED8"
          ]
        },
        "defaultRegionColor": {
          "type": "string",
          "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
          "examples": [
            "#1D4ED8"
          ],
          "description": "Fill for regions that get no color from `choropleth`/`categories`/`regions`. In choropleth mode `choropleth.noDataColor` overrides this. In categories mode this IS the no-data fill.\n"
        },
        "regionBorders": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "color": {
              "type": "string",
              "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
              "examples": [
                "#1D4ED8"
              ]
            },
            "width": {
              "type": "number",
              "minimum": 0,
              "maximum": 5
            }
          }
        },
        "mapBorder": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "color": {
              "type": "string",
              "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
              "examples": [
                "#1D4ED8"
              ]
            },
            "width": {
              "type": "number",
              "minimum": 0,
              "maximum": 10
            }
          }
        },
        "labels": {
          "type": "object",
          "additionalProperties": false,
          "description": "Region labels, off by default. Each map ships its own curated label set; on a map with `labels: false` in list_maps, `show: true` renders nothing and a `labels_unavailable` warning is reported.",
          "properties": {
            "show": {
              "type": "boolean",
              "default": false
            },
            "content": {
              "type": "string",
              "enum": [
                "name",
                "value"
              ],
              "default": "name",
              "description": "What each label prints. `name` is the region's name. `value` prints the region's choropleth number instead, formatted by the resolved `choropleth.format` (the same string the legend and tooltips show). Regions without a value get no label. Requires `choropleth`. With `categories`, or with neither, it is a `validation_error`. Labels are not collision-checked: a long number in a small region overflows it, exactly as in Studio."
            },
            "color": {
              "type": "string",
              "pattern": "^#([0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$",
              "examples": [
                "#1D4ED8"
              ]
            }
          }
        }
      }
    },
    "layers": {
      "type": "object",
      "additionalProperties": false,
      "description": "Extra 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.",
      "properties": {
        "admin0": {
          "type": "boolean",
          "description": "Surrounding land, as a filled area of neighbouring countries or states."
        },
        "admin0-mesh": {
          "type": "boolean",
          "description": "Country borders (mesh)."
        },
        "admin1-mesh": {
          "type": "boolean",
          "description": "First-level subdivision borders (states, provinces, regions)."
        },
        "admin1-mesh-inner": {
          "type": "boolean",
          "description": "State borders drawn over the map's own regions (county and ZIP maps, where `admin1-mesh` covers the surroundings only)."
        },
        "admin2-mesh": {
          "type": "boolean",
          "description": "Second-level subdivision borders (counties, districts)."
        },
        "lakes": {
          "type": "boolean",
          "description": "Major lakes."
        },
        "rivers": {
          "type": "boolean",
          "description": "Major rivers."
        },
        "roads": {
          "type": "boolean",
          "description": "Major roads."
        },
        "cities": {
          "type": "boolean",
          "description": "Major cities as labelled points."
        }
      }
    },
    "output": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "width": {
          "type": "integer",
          "minimum": 100,
          "maximum": 4000,
          "default": 1200,
          "description": "Image width in pixels. Default 1200."
        },
        "height": {
          "type": "integer",
          "minimum": 100,
          "maximum": 4000,
          "description": "Optional. When omitted, derives as a snug fit: the map's aspect ratio applied to the map area that remains after the title band (50 px) and any left/right legend column take their cut. A top/bottom legend adds its band (60 px for item legends, 70 px for gradient/steps bars) on top of that. An explicit height is delivered exactly, and the title and legend then shrink the map rather than the canvas.\n"
        },
        "scale": {
          "type": "number",
          "minimum": 1,
          "maximum": 4,
          "default": 1,
          "description": "PNG raster multiplier: the PNG is exactly round(width×scale) × round(height×scale) pixels. It has no effect on SVG output, but it is still tier-capped.\n"
        },
        "format": {
          "type": "string",
          "enum": [
            "png",
            "svg"
          ],
          "default": "png",
          "description": "`png` (default) or `svg`. SVG needs a Pro API key and is returned as a link. PDF is not available."
        }
      },
      "description": "Image 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 returned as a link 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."
    },
    "onUnmatched": {
      "type": "string",
      "enum": [
        "warn",
        "error"
      ],
      "default": "warn",
      "description": "warn = 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.\n"
    },
    "dryRun": {
      "type": "boolean",
      "default": false,
      "description": "Validate 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 anonymous renders per hour without a key)."
    }
  },
  "required": [
    "mapId"
  ],
  "additionalProperties": false
}

README.md9 KBView on GitHub

@ultimaps/mcp

An MCP server for Ultimaps. Ask Claude, Codex or any MCP client for a map and get the image back in the conversation. It covers choropleths from pasted numbers, category maps and pinned locations, for countries, states, provinces, counties, continents and the world.

"Map US states by population." · "Color the EU members by currency." · "Show France's regions with these unemployment rates: …" · "Pin our five offices on a map of Europe."

No account needed. Without an API key the server uses the keyless tier. Set ULTIMAPS_API_KEY for plan quotas and larger or unbranded output.

Can't run a local command? In ChatGPT (developer mode), claude.ai or any client that connects to remote MCP servers, add the hosted server instead: https://api.ultimaps.com/mcp. In ChatGPT, turn it on in each conversation where you want maps. It has the same three tools and nothing to install. See Hosted server. This package is the local version: requests come from your own IP address with your own key, and every image is saved to a file on your computer.

Tools

Tool	What it does
`render_map`	Renders a map as an image (PNG, or SVG with a Pro key), shown inline when it is small enough. Choropleth (numbers), categories (labels) or explicit colors, plus pins, title, legend, theme, labels and extra layers. Region names are matched fuzzily, and every correction or miss is reported with suggestions. `dryRun: true` previews matching and the color plan without rendering.
`list_maps`	The map catalog: `{id, title, regionType, layers, regionCount, labels}`, searchable with `query`.
`get_map_regions`	One map's region keys and titles, 200 per page, searchable by key, title or alias.

All three are read-only. Agents rarely need the discovery tools: render_map accepts region names, codes and aliases directly.

Install

Requires Node.js 20 or newer.

Claude Code

claude mcp add ultimaps -- npx -y @ultimaps/mcp
# with a key:
claude mcp add ultimaps --env ULTIMAPS_API_KEY=um_live_… -- npx -y @ultimaps/mcp

Codex

codex mcp add ultimaps -- npx -y @ultimaps/mcp
# with a key:
codex mcp add ultimaps --env ULTIMAPS_API_KEY=um_live_… -- npx -y @ultimaps/mcp

Codex writes TOML, not the JSON below. The equivalent entry in ~/.codex/config.toml (or .codex/config.toml in a trusted project):

toml

[mcp_servers.ultimaps]
command = "npx"
args = ["-y", "@ultimaps/mcp"]

Claude Desktop

Download ultimaps-<version>.mcpb from the latest release and open it: Claude Desktop installs it in one click and asks for the optional API key. Or add this to claude_desktop_config.json:

json

{
  "mcpServers": {
    "ultimaps": {
      "command": "npx",
      "args": ["-y", "@ultimaps/mcp"],
      "env": { "ULTIMAPS_API_KEY": "" }
    }
  }
}

Cursor

~/.cursor/mcp.json (or .cursor/mcp.json in a project):

json

{
  "mcpServers": {
    "ultimaps": { "command": "npx", "args": ["-y", "@ultimaps/mcp"] }
  }
}

VS Code

.vscode/mcp.json:

json

{
  "servers": {
    "ultimaps": { "type": "stdio", "command": "npx", "args": ["-y", "@ultimaps/mcp"] }
  }
}

Hosted server

You don't need this package to use the hosted server. Add the URL to your client:

claude mcp add --transport http ultimaps https://api.ultimaps.com/mcp
# with a key:
claude mcp add --transport http ultimaps https://api.ultimaps.com/mcp \
  --header "Authorization: Bearer um_live_…"

Clients with a config file take the URL alone, for example ~/.cursor/mcp.json:

json

{
  "mcpServers": {
    "ultimaps": { "url": "https://api.ultimaps.com/mcp" }
  }
}

The hosted server sends a key as an Authorization header, not as ULTIMAPS_API_KEY. In ChatGPT and claude.ai you can't set headers, so renders there use the anonymous tier: PNG up to 1600 px with attribution, up to 30 per hour per conversation. Every render also comes back as an image link that expires after 30 days. Images too large for the conversation, and all SVGs, come back only as the link. ChatGPT doesn't show images returned by tools, so the link is how you see the map there.

Configuration

Variable	Default	Purpose
`ULTIMAPS_API_KEY`	none (keyless)	API key from Studio → Workspace → API. An invalid key is an error and never falls back to keyless.
`ULTIMAPS_API_URL`	`https://api.ultimaps.com`	Point at a local API during development (`http://localhost:3001`). Plain http is only accepted for localhost.

Limits

	Keyless	Free key	Pro key
Renders	30/hour, 5/minute	500/month, 50/day, 10/minute	5,000/month, 1,000/day, 30/minute
Output	PNG up to 1600 px, attribution	PNG up to 1600 px at scale 2 (a 3200 px raster), attribution	PNG up to 4000 px at scale 4, SVG, no attribution

All keys in a workspace share the monthly quota. The daily and per-minute caps are per key, so a free key stops at 50 renders a day long before the month runs out.

Dry runs skip the monthly quota but still count against rate limits. When five or fewer keyless renders remain in the hour, the result says so.

What a render returns

The image, inline, when it is small enough (781 KB for PNG, 98 KB for SVG). The default 1200 px width usually fits. Every render is also written to <tmpdir>/ultimaps-mcp/ and the path is in the result, so in a terminal client the file is the thing you can actually open. Nothing is re-rendered or resampled on your behalf.
A text report: auto-corrected and unmatched region keys with suggestions, the resolved choropleth plan, warnings (such as layer_unavailable), a link to open the map in Ultimaps Studio for editing, and the render id for support.
An embeddable image URL for keyless PNG renders whose whole spec fits a ~2,000-character URL, so small datasets only. The URL carries the spec, not the image, and renders keyless, so it is not offered when a key is set.
structuredContent with the same report as data, described by the tool's outputSchema.

Privacy Policy

This server runs on your machine, has no telemetry of its own and talks only to the Ultimaps API (https://api.ultimaps.com, or the ULTIMAPS_API_URL you set). The full Ultimaps privacy policy is at ultimaps.com/privacy-policy.

What is sent to Ultimaps. Tool calls are ordinary HTTPS requests to the Ultimaps API, so they arrive from your IP address with an ultimaps-mcp/<version> user agent. render_map sends the whole map request: region keys and values, pins, title and styling. If you set ULTIMAPS_API_KEY, it is sent with render requests only.

What Ultimaps keeps. Each render request is logged: the request content, the map and outcome, timing, your IP address and user agent, and for keyed requests which key and workspace made it. This lets support look up a render id, lets the "Open in Studio" link rebuild your map, and counts usage. The request content is kept for 30 days and the IP address and user agent for 90 days. What remains is a usage record, tied to your workspace when a key was used. Ultimaps uses a third-party error-monitoring service that may receive details of a failed request. Ultimaps does not sell this data or use it for advertising.

What stays on your machine. Every rendered image is written to <tmpdir>/ultimaps-mcp/ and this server never deletes it. What your MCP client keeps, including tool results in your conversation, is governed by its own privacy policy.

Shareable links. The embeddable image URL offered for small keyless renders contains the full map request. Anyone with the link can read it.

The hosted server. The server at https://api.ultimaps.com/mcp runs on Ultimaps' servers, not yours, so the section above about your machine doesn't apply to it. The full privacy policy covers it.

Questions or deletion requests: support@ultimaps.com, quoting the render id.

Development

npm install
npm run typecheck
npm test           # unit + in-process protocol tests
npm run build      # → dist/

End-to-end over stdio against a real API (spends render units from your tier):

npm run build
node scripts/smoke.mjs

src/generated/render-request.schema.json is generated from the Ultimaps API contract; do not edit it by hand. Tool and property descriptions live in src/descriptions.ts. Arguments are never validated locally: the API is additive-only, and its 400 responses carry suggestions.

Issues and pull requests are welcome. Releases are cut by the Ultimaps team, and accepted changes ship with the next release.

The package publishes a bin and nothing else. import '@ultimaps/mcp' is not supported and fails by name, because dist/index.js starts a stdio server when it loads.

License

Install

Tools (3)

list_mapsget_map_regionsrender_map

Configuration

Environment variables

ULTIMAPS_API_KEYsecret

Optional API key. Without one you get 30 maps per hour with attribution. A key raises the limits, and a Pro key adds SVG, larger PNGs and no attribution.

Add to VS Code Add to Cursor

claude_desktop_config.json

json

{
  "mcpServers": {
    "mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@ultimaps/mcp@0.1.0"
      ],
      "env": {
        "ULTIMAPS_API_KEY": "<YOUR_ULTIMAPS_API_KEY>"
      }
    }
  }
}

com.ultimaps/mcp — MCP Server

🛠️ Key Features

🚀 Use Cases

⚡ Developer Benefits

⚠️ Limitations

list_maps

get_map_regions

render_map

@ultimaps/mcp

Tools

Install

Claude Code

Codex

Claude Desktop

Cursor

VS Code

Hosted server

Configuration

Limits

What a render returns

Privacy Policy

Development

License

Install

Configuration

Related servers