---
title: Agent docs
built: 2026-10-30
html: https://insurgently.com/projects/topic-map/technical/agents
---
# Agent docs

> Index of these files: https://insurgently.com/projects/topic-map/technical/agents/llms.txt

What a coding agent needs to build a plugin on Topic Map.

Every page here is Markdown at its own address. The same files ship inside the API package, matched to the version you install.

## Give your agent this

Paste these lines into your plugin's `AGENTS.md`. Agents read that file every session; without the pointer, most never look inside `node_modules`.

```md
## Topic Map
Before writing code that calls Topic Map, read
node_modules/@insurgently/topic-map-api/AGENTS.md.
It matches the installed version; prefer it to what you remember.
```

## The files

Short pages, each about one thing. An agent reads `AGENTS.md` first and follows its links.

- [AGENTS.md](https://insurgently.com/projects/topic-map/technical/agents/AGENTS.md): Nine rules for a plugin that calls Topic Map, and where everything else is.
- [README.md](https://insurgently.com/projects/topic-map/technical/agents/README.md): Examples for search, the map, map layers and the catalog calls.
- [Changelog](https://insurgently.com/projects/topic-map/technical/agents/CHANGELOG.md): What each API version added, and what broke.
- [Glossary](https://insurgently.com/projects/topic-map/technical/agents/ia.json): The terms, with meanings, ids, icons and code names.
- [llms.txt](https://insurgently.com/projects/topic-map/technical/agents/llms.txt): The index: one line per file. `llms-full.txt` is all of them in one file.

## Where they live

- **In the API package:** `node_modules/@insurgently/topic-map-api/`: `AGENTS.md`, `README.md`, `CHANGELOG.md` and `ia.json`. Matched to the installed version, and there offline.
- **On this site:** The latest release. Every page has a `.md` twin at the same address, which an agent also gets by asking for Markdown, and a **Copy as Markdown** button. `llms.txt` and `llms-full.txt` sit beside them.
- **In the repo:** Where the files are written. The `AGENTS.md` at the repo's root is for agents working on Topic Map itself; `api/AGENTS.md` is the one for callers.

## How they stay current

- Each page here starts with the date it was built and its source in the repo.
- The pages are the package's own files, copied at release, so the site and the package can't disagree.