# Files for agents

Machine-readable files, each for a different consumer.

| File                                                   | For                                                          |
| ------------------------------------------------------ | ------------------------------------------------------------ |
| [`/SKILL.md`](https://weirapp.io/SKILL.md)             | The agent manifest. Written for a model.                     |
| [`/llms.txt`](https://weirapp.io/llms.txt)             | A short index: what Weir is, how to connect, every endpoint. |
| [`/llms-full.txt`](https://weirapp.io/llms-full.txt)   | All of these docs in one file, with every endpoint's price.  |
| [`/openapi.json`](https://api.weirapp.io/openapi.json) | The full contract, OpenAPI 3.1. Generate clients from it.    |

This documentation site serves its own `/llms.txt` and `/llms-full.txt` too, built from the same
pages you are reading.

## Every page here is also Markdown

Append `.md` to any URL:

```
/pagination      → the page
/pagination.md   → the same content, as Markdown
```

Including the generated endpoint pages. It is the exact string the HTML was built from, so the two
cannot disagree.

## `SKILL.md`

Point an agent at it and it integrates without reading anything else. It covers what human
documentation leaves out because a person infers it: when _not_ to call the API, which mistakes
cost money, and which errors are a dead end.

It also resolves at `/skill.md` and `/Skill.md`.

## The contract

Generated from the route definitions and guarded by a test that fails the build if the two drift.

- **Genuinely 3.1.** Nullability is a type union, not the removed `nullable` keyword, so X's
  nullable counts generate as nullable in your client.
- **Every operation's price is in it.** The `x-weir-billing` extension gives the credits per call,
  the credits per returned item, and the rate-limit weight. The reference pages read it from there,
  so a price shown here is the price charged.
- **Stable `operationId`s.** One name per operation, everywhere. `searchReddit` is the reference page
  `/reference/reddit/searchReddit` and the MCP tool `search_reddit`.

## Where to read it

| Surface                                                | For                                              |
| ------------------------------------------------------ | ------------------------------------------------ |
| [Reference pages](/reference/reddit/searchReddit)      | Reading. One page per operation, with its price. |
| [`/openapi.json`](https://api.weirapp.io/openapi.json) | Generating a client.                             |
| [Console](https://weirapp.io/dashboard/playground)     | Running a real request and seeing what it cost.  |