Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,39 @@ Maintained by Identities AI, Inc. Ratify Protocol™ and identities.ai™ are tr

---

## Use Ratify with agent platforms

The protocol SDKs provide the portable authority primitive. Executable
[reference integrations](references/README.md) show where that primitive fits
inside real agent platforms and where the receiving system enforces it.

### GitHub Copilot and MCP

[Run the GitHub Copilot reference](references/github-copilot/README.md) to see
Copilot call an ordinary MCP deployment tool while an independent receiver
verifies that a recognized principal authorized the exact repository, service,
environment, artifact, and invocation before its protected handler runs.

```mermaid
flowchart LR
A[GitHub Copilot] --> B[Ratify MCP adapter]
C[Signed delegated authority] --> B
B --> D[Independent receiver]
D -->|valid and bounded| E[Invoke protected action]
D -->|changed, revoked, replayed, or untrusted| F[Deny]
```

Use a reference when you want to answer “How does Ratify fit into my agent
stack?” Use an SDK when you are building your own presenter or receiver. See the
[reference index](references/README.md) for every integration currently merged
and its endorsement and production status.

---

## Table of contents

- [The mental model](#the-mental-model)
- [Use Ratify with agent platforms](#use-ratify-with-agent-platforms)
- [The three verbs](#the-three-verbs)
- [How the bytes flow](#how-the-bytes-flow)
- [60-second install + verify](#60-second-install--verify)
Expand Down
47 changes: 38 additions & 9 deletions references/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,46 @@
# Ratify reference profiles

Reference profiles show how Ratify composes with a specific agent framework,
transport, runtime, or platform without changing the Ratify verifier contract.
They are larger and more platform-specific than the small examples in
Reference profiles answer a practical question: **where does Ratify fit in the
agent stack I already use, and which system must verify authority before the
action occurs?**

They are executable integrations for specific agent frameworks, transports,
runtimes, and platforms. Each turns the protocol into a visible outcome: one
properly authorized request reaches a protected handler, while an out-of-scope,
changed, expired, revoked, replayed, or untrusted request does not.

## Available references

| Platform | What it demonstrates | Run it |
| --- | --- | --- |
| [GitHub Copilot and MCP](github-copilot/README.md) | Copilot invokes a deployment tool; an independent receiver verifies exact delegated authority first | `cd references/github-copilot && ./run-reference-check.sh` |

Only references merged into `main` appear here. The
[`registry/`](registry/README.md) records exact versions, evidence, and whether
the named platform reviewed or endorsed each integration.

## Why use a reference?

- **Developer:** start from working adapter and receiver code instead of
inventing the integration and trust boundary yourself.
- **Platform team:** see exactly where authority presentation belongs in the
runtime and where enforcement must remain independent.
- **Security or IAM team:** evaluate concrete allow and deny evidence before
considering production deployment.
- **MCP or SaaS provider:** test how to accept consequential calls from agents
issued by customers, partners, or other organizations.

References are larger and more platform-specific than the small examples in
[`demos/`](../demos/README.md).

These are open-source interoperability references, not hosted services or
production support commitments. They make the integration pattern inspectable,
portable, and reproducible. **Ratify Verify** is the separate managed commercial
surface for operating the same protocol at scale: managed trust configuration,
revocation, policy, audit retention, observability, availability, and supported
deployment adapters. The proof bytes and verifier semantics remain portable;
customers choose whether to operate them themselves or use the managed service.
production support commitments. Use them now for evaluation, integration work,
or as the basis of a self-operated implementation. **Ratify Verify** is the
managed commercial surface under development for organizations that need
operated trust configuration, revocation, policy, replay protection, audit
retention, observability, availability, and supported deployment adapters.
Each profile explains how to join the design-partner path when that is the
better fit. Proof bytes and verifier semantics remain portable.

Every accepted profile should contain:

Expand Down
Loading