Skip to content

Improve README — add badge, capabilities, Smithery install, links #12

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

Open
adi-singh13 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve README — add badge, capabilities, Smithery install, links #12

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
37 changes: 30 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# AgentMail MCP Server

The AgentMail MCP Server provides tools for the AgentMail API.
[![npm](https://img.shields.io/npm/v/agentmail-mcp)](https://www.npmjs.com/package/agentmail-mcp)

## Setup
Connect any MCP-compatible AI client to email via [AgentMail](https://agentmail.to) — the email API for AI agents.

### Credentials
Works with Claude Desktop, Cursor, Windsurf, and any client that supports [Model Context Protocol](https://modelcontextprotocol.io).

Get your API key from [AgentMail](https://agentmail.to)
## Setup

### Configuration
1. Get a free API key at [console.agentmail.to](https://console.agentmail.to)
2. Add to your MCP client config:

```json
{
Expand All @@ -24,12 +25,16 @@ Get your API key from [AgentMail](https://agentmail.to)
}
```

### Install via Smithery

```bash
npx @smithery/cli@latest mcp add agentmail
```

## Tool Selection

By default, all available tools are loaded. You can selectively enable specific tools using the `--tools` argument with a comma-separated list of tool names.

### Example

```json
{
"mcpServers": {
Expand All @@ -43,3 +48,21 @@ By default, all available tools are loaded. You can selectively enable specific
}
}
```

## What Your Agent Can Do

- **Create inboxes** — give each agent its own email address
- **Send & receive email** — full two-way email communication
- **Reply in threads** — maintain conversation context
- **Manage attachments** — send and receive files
- **Search emails** — semantic search across inbox content
- **Organize with labels** — tag and filter messages

## Links

- [AgentMail](https://agentmail.to) — The email API for AI agents
- [Documentation](https://docs.agentmail.to)
- [Python SDK](https://github.com/agentmail-to/agentmail-python)
- [TypeScript SDK](https://github.com/agentmail-to/agentmail-node)
- [AgentMail Toolkit](https://github.com/agentmail-to/agentmail-toolkit) — OpenAI + Vercel AI SDK integrations
- [Discord](https://discord.gg/ZYN7f7KPjS)