# AI & Agents

Machine-readable Safeput documentation and guidance for coding agents.

Safeput documentation is available in formats that coding agents can consume
without scraping the rendered interface:

- [`/llms.txt`](/llms.txt) is the concise documentation map.
- [`/llms-full.txt`](/llms-full.txt) contains the complete documentation set.
- [`/openapi.yaml`](/openapi.yaml) is the public API contract.
- Every documentation page also has a Markdown representation by adding `.md`
  to its route, for example [`/docs/quickstart.md`](/docs/quickstart.md).

## Recommended agent workflow

1. Read `llms.txt` to find the smallest relevant set of pages.
2. Use OpenAPI for paths, authentication, status codes, and schemas.
3. Keep the project API key in trusted backend code.
4. Use a unique idempotency key when creating an upload.
5. Treat bytes as untrusted until Safeput returns a terminal clean verdict.
6. Verify the integration with a test project before using a live project.

## MCP roadmap

An MCP server is planned after the public API contract is stable. It will expose
Safeput as an agent capability rather than duplicating documentation search.
Candidate tools include `safeput.create_upload`, `safeput.get_upload`,
`safeput.get_scan_result`, `safeput.retrieve_file`, and `safeput.get_usage`, with
documentation exposed as MCP resources.

Until then, OpenAPI plus Markdown documentation is the supported agent
integration surface. No Safeput MCP endpoint is available today.
