inlinedocs
Portal ↗

Reference

For AI agents

These docs are AI-native. Everything a human reads here is also available in clean, machine-readable form, so that LLMs, coding assistants, and agents can consume it accurately with no HTML noise to parse.

# Machine-readable endpoints

File What it is
/llms.txt A compact index: the project summary plus a link to every page’s Markdown. Small enough to load whole into a modest context window.
/llms-full.txt The entire documentation concatenated as one Markdown file — for systems that can take the whole corpus at once.
‹page›.md Every page is also served as raw Markdown at its own .md URL (e.g. review-pipeline.md).

Each HTML page also declares its Markdown twin via <link rel="alternate" type="text/markdown">, so a well-behaved fetcher can discover it automatically.

# Why this matters

The same qualities that make docs good for humans make them good for models: clear headings, short paragraphs, real tables, honest language, and one idea per section. inline follows the emerging llms.txt convention so AI tools find the canonical source instead of guessing from rendered HTML. (background on llms.txt →)

# Driving inline as an agent

If you’re a coding agent, the most useful thing inline offers you is a pre-PR review over MCP: ask inline to review your working tree before you open the pull request, using the same pipeline that reviews real PRs.

bash
claude mcp add --transport http inline \
  https://inline.dev/api/mcp \
  --header "Authorization: Bearer ink_live_xxxxxxxx"

Then call review_changes with your diff and files. See MCP: pre-PR review → for the tools, depths, and key management.

# The safety contract

inline’s own use of AI follows a rule worth knowing if you integrate with it:

AI proposes, the pipeline verifies, a human approves. Findings are suggestions; fixes are pull requests you review; suppression rules wait for approval; offensive tooling is fenced by an enforced denylist, not a prompt. See security & trust.

# How these docs are maintained

The site is generated from plain Markdown — one file per page, with a little front-matter. To add or edit a page you change Markdown and rebuild; the theme, syntax highlighting, search index, and these llms.txt files all regenerate automatically. That keeps the docs easy to keep correct, which is the real prerequisite for being AI-friendly: version-accurate content beats clever formatting every time.