AI Integration

routar ships with resources so AI coding assistants (Claude Code, Copilot, Cursor) give accurate, routar-specific suggestions out of the box.

llms.txt

Two machine-readable documentation files are available at the root of this site:

These follow the llms.txt standard . You can point any AI tool directly at these URLs for up-to-date routar documentation.

AGENTS.md

AGENTS.md at the repository root is a reference guide for AI agents. It covers the core patterns, executor selection, SSR/CSR setup, MSW testing, and common anti-patterns.

Copy the relevant sections into your own project’s AGENTS.md so AI assistants understand how your API layer is structured:

<!-- In your project's AGENTS.md -->
## API layer
 
This project uses routar. See https://github.com/minr2kb/routar/blob/main/AGENTS.md
for patterns, executor selection, and anti-patterns.

IDE experience (JSDoc)

Every exported function in @routar/core and @routar/msw ships with @example blocks in the published .d.ts files. Hover docs and inline suggestions work immediately after npm install — no configuration needed.

// Hover over endpoint( in your editor:
endpoint({
  method: 'GET',
  path: '/:id',
  request: z.object({ path: z.object({ id: z.number() }) }),
  response: TodoSchema,
});
 
// Hover over createMswHandlers( in your editor:
const server = setupServer(
  ...createMswHandlers(todoRouter, 'https://api.example.com', {
    getList: () => HttpResponse.json([]),
    getDetail: ({ params }) => HttpResponse.json({ id: params.id }),
  }),
);