English Français العربية

Pidgeon

السجل الرسمي الإنتاجية

Email inboxes for AI agents: their own addresses, threads, sending, replies and arriving mail.

الشيفرة المصدرية الموقع التوثيق

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

Remote (streamable-http)
Claude Code 
claude mcp add --transport http pidgeon 'https://pidgeon.ai/api/mcp' --header 'Authorization: <Your Pidgeon API key as a bearer token>'
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "pidgeon": {
            "type": "http",
            "url": "https://pidgeon.ai/api/mcp",
            "headers": {
                "Authorization": "<Your Pidgeon API key as a bearer token>"
            }
        }
    }
}
NPM package @pidgeon-ai/mcp
Claude Code 
claude mcp add pidgeon -e 'PIDGEON_API_KEY=<your pidgeon_api_key>' -- npx -y @pidgeon-ai/mcp@0.18.0
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "pidgeon": {
            "command": "npx",
            "args": [
                "-y",
                "@pidgeon-ai/mcp@0.18.0"
            ],
            "env": {
                "PIDGEON_API_KEY": "<your pidgeon_api_key>"
            }
        }
    }
}

متغيرات البيئة

  • PIDGEON_API_KEY إلزامي سري Your Pidgeon API key (pgn_live_…). Make one under Developers → API keys, or let an agent sign itself up: https://pidgeon.ai/skill.md

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

Pidgeon for JavaScript and TypeScript

Mailboxes for AI agents. Pidgeon is the email inbox API for AI agents. It gives agents their own inboxes so they can work with emails just like a human.

pidgeon.ai · Documentation

npm install @pidgeon-ai/sdk

Create an address, send from it, wait for the answer, and reply in the thread:

import {
  client,
  identitiesCreate,
  messagesAwait,
  messagesReply,
  messagesSend,
} from '@pidgeon-ai/sdk';

client.setConfig({ auth: () => process.env.PIDGEON_API_KEY! });

// 1. An address of its own. Any free name on pidgeon.email works with no DNS.
const { data: address } = await identitiesCreate({
  body: { address: 'scout@pidgeon.email', type: 'agent' },
  throwOnError: true,
});

// 2. Send from it.
await messagesSend({
  body: {
    from: address.data.email,
    to: 'ops@example.com',
    subject: 'Staging access',
    text: 'Could you send me the access code?',
  },
  throwOnError: true,
});

// 3. Receive: one held-open request until the answer arrives, up to 60 seconds.
const { data: awaited } = await messagesAwait({
  query: { identity_id: address.data.id, timeout: 60 },
  throwOnError: true,
});

// 4. Reply into the same conversation. Recipients and subject come off the original.
if (awaited.data.message) {
  console.log(awaited.data.message.extracted.codes);
  await messagesReply({
    path: { id: awaited.data.message.id },
    body: { text: 'Thanks, that worked.' },
    throwOnError: true,
  });
}

PIDGEON_API_KEY is a pgn_live_… key. Make one at pidgeon.ai/app/developers/keys, or let your agent sign itself up: pidgeon.ai/skill.md.

The packages

PackageInstallWhat it is
@pidgeon-ai/sdknpm install @pidgeon-ai/sdkThe TypeScript client, one function per operation
@pidgeon-ai/clinpm install -g @pidgeon-ai/cliEvery endpoint as a command
@pidgeon-ai/mcpnpx -y @pidgeon-ai/mcp initThe MCP server, run on your machine
@pidgeon-ai/ai-sdknpm install @pidgeon-ai/ai-sdk ai zodThe same tools, for the Vercel AI SDK
@pidgeon-ai/openclawopenclaw plugins install @pidgeon-ai/openclawEmail as an OpenClaw channel: mail starts a conversation, the reply goes in the thread

examples/openai-agents is an OpenAI Agents SDK agent on the hosted server, which needs no package of ours.

An MCP client needs no package at all. Point it at https://pidgeon.ai/api/mcp and it signs you in with OAuth:

claude mcp add --transport http pidgeon https://pidgeon.ai/api/mcp

The plugin for Claude Code, Codex, Cursor and Gemini CLI is pidgeon-ai/pidgeon-plugins.

Contributing

The SDK and the CLI are generated from openapi.json, which is the contract the API validates against and is published at https://pidgeon.ai/openapi.json. The application that serves it is closed source; these clients are not, and this is where they are readable. This repository is copied from that one on every release.

So a pull request against generated code cannot be merged as written — the fix belongs in the schema it came from. Open an issue instead and say what is wrong; that is the faster route either way, because a wrong field here is a wrong field in the published contract and in the Python client too.

Issues and questions: open one, or email support@pidgeon.ai.

MIT licensed.

الأسئلة الشائعة

ما هو Pidgeon؟

Email inboxes for AI agents: their own addresses, threads, sending, replies and arriving mail.

كيف أثبّت Pidgeon؟

يعمل كخادم بعيد. في Claude Code: claude mcp add --transport http pidgeon 'https://pidgeon.ai/api/mcp' --header 'Authorization: <Your Pidgeon API key as a bearer token>'. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج Pidgeon إلى مفتاح API؟

نعم. يتطلب PIDGEON_API_KEY, Authorization، وتضبطها في إعداداته.

هل Pidgeon مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون Pidgeon؟

ينشره pidgeon-ai. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.