Skip to content

Add "Use with AI agents" section to README #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xehl merged 1 commit into from
Mar 5, 2026
Merged

Add "Use with AI agents" section to README #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,24 @@ base64-encoding). Note that absolute paths will begin with `@file://` or
```bash
courier <command> --arg @data://file.txt
```

## Use with AI agents

The CLI works as a tool backend for AI coding agents. Because every API endpoint maps to a single shell command with structured JSON output, agents can call Courier without an SDK or custom integration.

```sh
export COURIER_API_KEY=your_api_key

# Send a message
courier send message \
--message.to.user_id "user-123" \
--message.template "order-confirmation" \
--message.data '{"orderId": "ORD-456"}'

# Check delivery status
courier messages list --recipient "user-123" --format json
```

For richer agent integration, Courier also provides an [MCP server](https://github.com/trycourier/courier-mcp) that exposes the full API as structured tools for Cursor, Claude Code, Windsurf, and other MCP-compatible clients.

See [Build with AI](https://www.courier.com/docs/tools/ai-onboarding) for setup instructions.
Loading