Source: https://developers.woosmap.com/products/build-with-ai/

> For clean Markdown of any page, append `.md` to the page URL.

> Routing index (which page answers which question): https://developers.woosmap.com/llms.txt

> Full page list: https://developers.woosmap.com/llms-full.txt

# Build with AI



Writing Woosmap code with Claude Code, Cursor or Copilot? Start here.

| Resource              | URL                                                                                            |
| --------------------- | ---------------------------------------------------------------------------------------------- |
| Rules for your agent  | [`/llms-rules.txt`](https://developers.woosmap.com/llms-rules.txt)                             |
| Skills for your agent | [`Woosmap/agent-skills`](https://github.com/Woosmap/agent-skills)                              |
| Routing index         | [`/llms.txt`](https://developers.woosmap.com/llms.txt)                                         |
| Full page list        | [`/llms-full.txt`](https://developers.woosmap.com/llms-full.txt)                               |
| OpenAPI 3.1 spec      | [`/assets/woosmap-openapi3.json`](https://developers.woosmap.com/assets/woosmap-openapi3.json) |

## Set up your agent

Add this line to `CLAUDE.md`, `.cursorrules`, `AGENTS.md`, or whatever file your tool reads:

```
Before writing any Woosmap API call, read and follow
https://developers.woosmap.com/llms-rules.txt
```

Use the URL rather than a copy. When a convention changes, the file changes with it.

The rules cover base URLs, which API key to use where, rate limits, and how to build a reference URL.

## Skills for your agent

The rules file is enough for most Woosmap code. For jobs where an agent needs more than the docs,
Woosmap publishes skills: Markdown the agent loads only when your request matches it, with the
steps and traps for that job. The skills point to the live docs and do not copy them.

Install all of them:

```bash
npx skills add Woosmap/agent-skills
```

See what is available, or install one with `--skill <name>`:

```bash
npx skills add Woosmap/agent-skills --list
npx skills add Woosmap/agent-skills --skill woosmap-google-maps-migration
```

The [repo README](https://github.com/Woosmap/agent-skills) describes each skill. Skills work with
Claude Code, Cursor and Copilot. Update them with `npx skills update`.

## Any page in Markdown

Append `.md` to a page URL for clean Markdown, with no HTML or navigation.

**An endpoint reference** gives you the whole contract in one request: method, base URL, rate limit,
auth schemes, every parameter with its type and default, the response schema, errors, and examples in
shell, JavaScript and Python.

```
/api-reference/localities-api/get-localities-autocomplete.md
```

**A code sample** gives you the working project: TypeScript, compiled JavaScript, CSS, HTML, and how
to run it locally.

```
/js-samples/render-shapes-data.md
```

**The Map JS reference** gives you every class, method and option in one file.

```
/products/map-api/reference/1.4.md
```

Product and guide pages work the same way.

```
/products/localities/overview.md
```

## Which index to load

Load [`/llms.txt`](https://developers.woosmap.com/llms.txt). It maps a question to the page that
answers it and lists every endpoint with its base URL. It fits in a context window.

[`/llms-full.txt`](https://developers.woosmap.com/llms-full.txt) lists every page. Use it to find
something, not in every conversation.

Generating a client or validating requests? Use
[the OpenAPI spec](https://developers.woosmap.com/assets/woosmap-openapi3.json) directly.

## Which product for which job

| I want to                                 | Use                                 |
| ----------------------------------------- | ----------------------------------- |
| Geocode an address, city or postal code   | Localities API                      |
| Search my own stores or assets            | Stores API                          |
| Store geometries and query them spatially | Datasets API                        |
| Travel time, distance, routes or tolls    | Distance API                        |
| Public-transport routing and schedules    | Transit API                         |
| Locate a device from its IP               | Geolocation API                     |
| Show an interactive map on the web        | Map JS API                          |
| Put a map image in an email or PDF        | Static Map API                      |
| Add a store locator without building one  | Store Locator Widget                |
| Track entry and exit from zones on mobile | Geofencing (Zones API + Mobile SDK) |
| Map the inside of a venue                 | Indoor API                          |
| Convert a three-word address              | What3Words API                      |
| Move an app off Google Maps               | Migration guides + migration skill  |
| Let an assistant call Woosmap at runtime  | MCP Server                          |

## Which pages to trust

**Endpoint references under `/api-reference/` are authoritative.** They come from the OpenAPI spec,
so parameter names, types, defaults and rate limits match what the API accepts.

**Product pages and samples are narrative.** They show one call and leave out most parameters. Read
them to understand a product, not to build a request.

Reference URLs are verb-prefixed and path-flattened:

```
GET /localities/autocomplete
  -> /api-reference/localities-api/get-localities-autocomplete.md
```

Take these URLs from the routing index instead of assembling them.

## Let an agent call the API

To have an agent do the location work rather than write code for it, use the
[Woosmap MCP Server](https://developers.woosmap.com/products/mcp-server/overview/). It exposes
geocoding, search, routing and distance as tools.

## Something wrong?

The Markdown pages are generated, so a broken one is a bug we can fix. Post the page URL on the
[Woosmap Community forum](https://forum.woosmap.com/).