Instant Map / AI agents
Written for the agent doing the work.
Paste one prompt into Claude Code, Cursor or Codex and it has what it needs: an index to read first, a guide for your framework, the exact API, and a way to check the result.
The prompt
It tells the agent where to read, what to install, how to render the first image on the server, and what to verify in the running app before it says it is done.
Add an Instant Map to this project.
1. Read https://instantmap.org/llms.txt, then the framework guide for this project's stack from https://instantmap.org/docs/frameworks/ (append .md to any docs URL for Markdown).
2. Install the package: npm install instantmap-js
3. Render the map where I ask, with an explicit height, centred on my data, and pass my records as markers: { id, lng, lat, label, title, subtitle, image, href }.
4. If the framework renders on the server, render the first image on the server as the guide shows, so the map appears before any JavaScript runs.
5. If the project has brand colours or design tokens, build the map colours from them with brandTheme() and use the same result for the first image and the live map.
6. Run the app and check: the image appears, the map moves when dragged, and clicking a marker opens its card. Fix any console errors.Docs a model can read
- llms.txtA short index of the docs, for a model to read first.
- llms-full.txtThe whole manual in one Markdown file.
- SKILL.mdInstructions an agent can keep as a skill: the API, the rules and a checklist.
- Any page as MarkdownAdd .md to the address of any docs page.
- Agent guideHow to brief an agent and what to check afterwards.
- Questions and answersDirect answers to the common questions.
Easy to get right
One element, a short API
A custom element with a handful of attributes and one marker shape. There is little to guess and little to get wrong.
Exact reference pages
Every attribute, property, method and event is listed in tables, with types, so the agent does not invent options.
A check it can run
The prompt ends with what to verify: the image appears, the map drags, and a marker opens its card.