From 3a94b4ba9ae9a3ac930202d17b650a2e129b473d Mon Sep 17 00:00:00 2001 From: Adi Date: Tue, 31 Mar 2026 06:08:03 +0000 Subject: [PATCH] =?UTF-8?q?Improve=20README=20=E2=80=94=20add=20badge,=20c?= =?UTF-8?q?apabilities,=20Smithery=20install,=20links?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7e79efe..bfff50f 100644 --- a/README.md +++ b/README.md @@ -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 { @@ -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": { @@ -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)