Skip to content

Commit 862cbec

Browse files
committed
docs: fix 'start here' — hook is fastest path, daemon is required for both
The section was written before the daemon/hook split. Correct it: - daemon install is the prerequisite for both paths - obsigna-hook (one settings.json snippet) is the fastest entry point - mcp-proxy is the 'more control' path (policy, risk scoring) - remove the now-redundant '10-minute MCP quick start' section
1 parent 5aa8936 commit 862cbec

1 file changed

Lines changed: 26 additions & 37 deletions

File tree

README.md

Lines changed: 26 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,36 @@
4646

4747
## Start here
4848

49-
The fastest way to try Agent Receipts is to put [`mcp-proxy/`](mcp-proxy/) in front of an MCP server you already use.
49+
Both paths below require the daemon — it holds the signing key and owns the audit chain. Install it first:
5050

51-
In one step, you get:
51+
```bash
52+
brew install agent-receipts/tap/obsigna
53+
obsigna daemon start
54+
```
55+
56+
**Fastest path — PostToolUse hook (Claude Code):** one config snippet and every tool call gets a signed receipt automatically:
57+
58+
```json
59+
{
60+
"hooks": {
61+
"PostToolUse": [{ "matcher": "", "hooks": [{ "type": "command", "command": "obsigna-hook" }] }]
62+
}
63+
}
64+
```
5265

53-
- Signed receipts for every tool call
54-
- A tamper-evident audit chain you can verify later
55-
- Risk scoring and policy hooks without changing the client or server
66+
Add that to `~/.claude/settings.json`, then inspect the audit trail:
67+
68+
```bash
69+
obsigna list
70+
obsigna show <seq>
71+
obsigna verify
72+
```
5673

57-
If you want to audit GitHub MCP in a real agent workflow, start with:
74+
**More control — MCP proxy:** wraps any MCP server and adds policy hooks and risk scoring on top of signed receipts:
5875

59-
- [Claude Desktop integration](https://agentreceipts.ai/mcp-proxy/claude-desktop/)
60-
- [Claude Code integration](https://agentreceipts.ai/mcp-proxy/claude-code/)
61-
- [Codex integration](https://agentreceipts.ai/mcp-proxy/codex/)
76+
- [Claude Desktop setup](https://agentreceipts.ai/mcp-proxy/claude-desktop/)
77+
- [Claude Code setup](https://agentreceipts.ai/mcp-proxy/claude-code/)
78+
- [Codex setup](https://agentreceipts.ai/mcp-proxy/codex/)
6279

6380
## Project layout
6481

@@ -76,34 +93,6 @@ If you want to audit GitHub MCP in a real agent workflow, start with:
7693
| [dashboard](https://github.com/agent-receipts/dashboard) | Local web UI for browsing and verifying receipt databases |
7794
| [openclaw](https://github.com/agent-receipts/openclaw) | Agent Receipts plugin for OpenClaw |
7895

79-
## 10-minute audited MCP quick start
80-
81-
Install the proxy:
82-
83-
```bash
84-
go install github.com/agent-receipts/ar/mcp-proxy/cmd/obsigna-mcp@latest
85-
```
86-
87-
Wrap any MCP server:
88-
89-
```bash
90-
obsigna-mcp node /path/to/mcp-server.js
91-
```
92-
93-
Then point your agent client at the proxy instead of the raw server:
94-
95-
- [Claude Desktop setup](https://agentreceipts.ai/mcp-proxy/claude-desktop/)
96-
- [Claude Code setup](https://agentreceipts.ai/mcp-proxy/claude-code/)
97-
- [Codex setup](https://agentreceipts.ai/mcp-proxy/codex/)
98-
99-
Once your agent makes tool calls, inspect the signed audit trail:
100-
101-
```bash
102-
obsigna list
103-
obsigna show <seq>
104-
obsigna verify
105-
```
106-
10796
## SDK quick start
10897

10998
> **Choose your trust model.** The snippets below keep the signing key inside the

0 commit comments

Comments
 (0)