Docs target
The docs target writes llms.txt, llms-full.txt, tools.json and a README. This is the README tungsten generates for the example API.
Swagger Petstore API, version 1.0.0.
API version 1.0.0 · base URL http://petstore.swagger.io/v1 · 1 namespace · 3 callable operations · 0 planned
Files
| File | Purpose |
|---|---|
llms.txt | Index for agents: one line per callable operation with its safety tier and idempotency rule. |
llms-full.txt | Full reference for agents: arguments, responses, errors, remediation and types. |
tools.json | Function-calling manifest: one tool per callable operation, parameters as JSON Schema. |
Authentication
Auth: none declared.
Auth profiles: none; each operation names the schemes it needs (a + b all of, a | b any of).
openapi operations
Swagger Petstore (version 1.0.0).
| Operation | Endpoint | Summary | Safety | Idempotency |
|---|---|---|---|---|
openapi.pets.list | GET /pets | List all pets | read_only | none |
openapi.pets.create | POST /pets | Create a pet | mutating | none |
openapi.pets.get | GET /pets/{petId} | Info for a specific pet | read_only | none |
Errors
SDK calls never throw for API or transport errors: they return a result whose error is one envelope with category, retryable and remediation. llms-full.txt lists the API's error codes with their remediation.
| Category | When | Retryable by default |
|---|---|---|
VALIDATION_FAILED | arguments failed pre-flight validation, or a 400 with an error body | never |
MALFORMED_REQUEST | a 400 without an error body | never |
REQUEST_TOO_LARGE | 413 | never |
AUTH_FAILED | 401 or 403 | never |
NOT_FOUND | 404 | never |
CONFLICT | 409 | never |
PRECONDITION_FAILED | 402, 412 or 422 as the manifest says | never |
RATE_LIMITED | 429 | after_delay |
UPSTREAM_UNAVAILABLE | 502, 503 or 504 on a read | after_delay |
OUTCOME_UNKNOWN | a timeout, reset, ambiguous status or unexplained 5xx on a mutation | same_key_only (after_remediation without an idempotency key) |
TRANSPORT_FAILED | DNS, TLS or connection refused before sending | after_delay |
CONFIRMATION_REQUIRED | a destructive or irreversible call without confirmation | never |
GATE_DISABLED | a gated route answered with its disabled status | never |
UNEXPECTED_RESPONSE | a response that failed strict validation | never |
Regenerating
These files are generated from the API's OpenAPI documents and its tungsten manifests. Run tungsten generate after changing them; tungsten check --ci fails while these files are stale.