Skip to main content
info

This page is in development. What is written below is accurate, but the page is not finished and will gain content in a coming release.

MapCore MCP server

Preview

An initial version, built and distributed outside the SDK: it is not part of the installer or any package, and it is not on a public index. Ask your MapCore representative for the VS Code extension (.vsix) or the install source. Tool names and setup commands may change.

The MapCore MCP server answers MapCore questions inside your coding agent — Claude Code or GitHub Copilot Chat in agent mode. You describe what you want in your own words; it searches the real MapCore API and this documentation, and answers citing what it found and where.

What it knows is one release's documentation set — these pages, the release notes, the TypeScript declarations, and a structured model of every public C++ type and member with its documentation comment. All of it is indexed ahead of time and the index ships inside the package, so an answer can cite a guide, a release note or a method signature, and nothing at your end needs a MapCore checkout or a network connection.

Because the index is built from one release, the server answers about that release, and the version it was built from is recorded in the index it carries.

Why it exists​

Guessing at an API is the normal failure mode of a coding agent, and MapCore is unusually easy to guess wrong about:

  • Names that look guessable and are not. The same type is IMcMapDevice, IDNMcMapDevice or MapCore.IMcMapDevice depending on the language, and the factory that creates it moves too. A plausible-looking invention compiles nowhere. See the API name map.
  • Rules that are not in the signatures. A terrain or a layer is created with a reference count of zero. Nothing in Create()'s type says so, and missing it costs you a leak or a use-after-free rather than a compile error.
  • Fuzzy intent. "A polygon with rounded corners, not sharp points" could mean rounded line joins or a filled shape with rounded corners, and MapCore spells those differently. The server grounds the answer first and then asks which you meant, instead of picking one.

What it can do​

Three tools, and they are search tools rather than a wrapper over the API:

ToolDoes
mapcore_searchSearch the API and the documentation together for whatever is relevant to a description in your own words — interfaces, methods, enums, structs, sections of a guide, release notes — each with its documentation and where it comes from
mapcore_get_symbolReturn everything known about one exact name, taking either the qualified form (IMcMapCamera::SetCameraPosition) or the bare method name, and combining the JS/TS and C++ sides where both exist
mapcore_list_symbolsList API symbols for discovery, filtered by kind — interface, class, struct, enum, function, typedef — or by a substring of the name. Symbols only: guides and release notes do not turn up here

An agent will normally call these itself. You can also name one directly if it does not.

Install​

The easiest route is the VS Code extension, which is self-contained: the server and every dependency ship as wheels inside the .vsix, so it installs with nothing to reach on the network.

  1. Install the .vsix in VS Code — Extensions ▸ ⋯ ▸ Install from VSIX.
  2. Run MapCore API Assistant: Setup from the Command Palette. It bootstraps uv if it is missing, installs the server, and registers it with whichever clients you have. Every step is safe to re-run.
  3. Restart VS Code. In Copilot Chat, switch to Agent mode and approve mapcore-api-assistant when prompted; Claude Code prompts separately.

If you would rather install it as a command-line tool, you need Python 3.11.4+ and uv:

uv tool install --from <install source> mapcore-api-assistant
mapcore-api-assistant setup --target both

--target takes claude, vscode or both. Use uv tool install and not uvx: the setup step registers a long-lived server command that your client will spawn again on every start, so the tool has to stay on PATH afterwards.

To confirm Claude Code sees it:

claude mcp list

mapcore-api-assistant ✓ Connected means you are done. To register it again from scratch, remove it first with claude mcp remove mapcore-api-assistant --scope user.

Your code stays on your machine​

Retrieval is entirely local. Your question is turned into a vector on your own machine and matched against the shipped index — there is no cloud service behind this server and nothing you type reaches one. (Your agent is a separate matter: whatever the server returns becomes part of the conversation your client is already having with its own model.)

The one thing it fetches is the embedding model, once, at about 66 MB. If that download is blocked the server does not fail — it degrades to keyword search and says so in its answer. For a machine with no route out, install with mapcore-api-assistant setup --offline <bundle-dir>, or point MAPCORE_MODEL_DIR at a directory holding the model files.

What it does not do​

It answers questions about the API; it does not run MapCore. It cannot see your application, your map or your data, and it does not execute anything on your behalf — so nothing it says is checked against a running session.

It also does not remove the need to understand the SDK. The rules that decide whether MapCore code actually works — the ownership graph, which calls belong on the main thread, which coordinate frame a number is in — are in Threading and lifecycle and Coordinate systems, and the server will cite them rather than replace them.

  • API reference — the same API the server searches, for reading yourself.
  • MapCore CLI — a tool that does drive a live map session, from a terminal.
  • Architecture — the object model the answers are about.