Introduction
This section provides a high-level overview of what Readit is, its core principles, and how you can get started in seconds.
What is Readit?
Section titled “What is Readit?”Readit is a Context Injection System for AI Agents. It allows you to package all the necessary context for a task—instructions, reference documents, prompts, and even dynamic data sources—into a simple, portable Markdown link called a “Readit.”
When an AI model consumes a Readit link, it uses the provided Markdown as its complete operating context. This solves critical problems in working with LLMs:
Minimizes Hallucinations: By providing a clear and bounded context, the model is less likely to invent facts or go off-topic.
Ensures Reproducibility: The same Readit will produce consistent outputs across different agents and sessions.
Mental Model
Section titled “Mental Model”A Readit is a context bundle: instructions + references + links + dynamic assets. An agent fetches it as raw Markdown and uses it as operating context for a task.
Key Principles
Section titled “Key Principles”Readit is built on three core principles:
-
Stateless & Ephemeral: Readits are designed to be loaded, used, and forgotten. There’s no persistent state on the agent’s side. Links can even have a Time-To-Live (TTL) for temporary access.
-
Markdown-based: Simplicity is key. Using Markdown makes Readits easy to create, read, edit, and version-control using familiar tools.
-
Secure: Share your contexts confidently. Use public links for open documentation or tokenized links for private and unlisted content that you control.
Basic Usage
Section titled “Basic Usage”# Paste this alongside your AI prompt:https://readit.md/your-token/my-context
# The AI will automatically load and use the contextExample prompt:
Please review this code following the guidelines here: https://readit.md/abc123.../code-review-standards
[Your code here]