packages/mcp-server (@scribase-mail/mcp-server, MIT): - 16 tools: send_email, batch_send_emails, get/list/cancel/reschedule email, list/get/create/verify/delete domain, list/create contact, list/get broadcast, list/get received emails - Stdio transport entry (scribase-mail-mcp bin, npx-ready) - Streamable HTTP transport: createWebHandler() for Next.js/edge, createNodeHandler() for Express/bare Node; standalone server on MCP_PORT - ScribaseMailClient fetch wrapper; resolveApiKey reads SCRIBASE_MAIL_API_KEY | RESEND_API_KEY - 11 vitest tests (mocked fetch); all pass packages/cli (@scribase-mail/cli, MIT): - scribase-mail bin using commander - Commands: login (stores key in ~/.config/scribase-mail/config.json mode 600), emails send/get/list/cancel/reschedule, domains add/verify/list/get/delete, api-keys list/create/delete - Respects SCRIBASE_MAIL_API_KEY | RESEND_API_KEY | SCRIBASE_MAIL_BASE_URL | RESEND_BASE_URL - 9 vitest tests (mocked fs); all pass apps/docs: - guides/resend-migration.mdx: 1-minute migration, API compat matrix, differences table, env vars reference - guides/supabase-smtp.mdx: custom SMTP setup with step-by-step Supabase guide (both dashboard and self-hosted env vars) - guides/neon.mdx: Next.js + Neon quickstart (App Router server action + Pages Router API route, scheduling, error handling) - guides/mcp-server.mdx: Claude Desktop, Cursor, remote HTTP, Caddy rewrite, tool table, env vars - guides/cli.mdx: full CLI usage reference with jq examples - guides/webhooks.mdx: added Svix ↔ X-UseSend-Signature mapping note - docs.json: navigation updated to include all 5 new guide pages Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
187 lines
4.9 KiB
JSON
187 lines
4.9 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "maple",
|
|
"name": "Scribase Mail",
|
|
"colors": {
|
|
"primary": "#111111",
|
|
"light": "#F5F5F5",
|
|
"dark": "#111111"
|
|
},
|
|
"background": {
|
|
"color": {
|
|
"light": "#FAFAFA",
|
|
"dark": "#0D0D0D"
|
|
}
|
|
},
|
|
"fonts": {
|
|
"family": "Inter"
|
|
},
|
|
"favicon": "/favicon.svg",
|
|
"navigation": {
|
|
"tabs": [
|
|
{
|
|
"tab": "Documentation",
|
|
"groups": [
|
|
{
|
|
"group": "Getting Started",
|
|
"pages": [
|
|
"introduction",
|
|
"get-started/nodejs",
|
|
"get-started/python",
|
|
"get-started/go",
|
|
"get-started/local",
|
|
"get-started/smtp"
|
|
]
|
|
},
|
|
{
|
|
"group": "Self Hosting",
|
|
"pages": [
|
|
"self-hosting/overview",
|
|
"self-hosting/oci-email-delivery"
|
|
]
|
|
},
|
|
{
|
|
"group": "Guides",
|
|
"pages": [
|
|
"guides/webhooks",
|
|
"guides/double-opt-in",
|
|
"guides/campaign-personalization",
|
|
"guides/use-with-react-email",
|
|
"guides/resend-migration",
|
|
"guides/supabase-smtp",
|
|
"guides/neon",
|
|
"guides/mcp-server",
|
|
"guides/cli"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "API Reference",
|
|
"groups": [
|
|
{
|
|
"group": "API Reference",
|
|
"pages": [
|
|
"api-reference/introduction"
|
|
]
|
|
},
|
|
{
|
|
"group": "Emails",
|
|
"pages": [
|
|
"api-reference/emails/get-email",
|
|
"api-reference/emails/list-emails",
|
|
"api-reference/emails/send-email",
|
|
"api-reference/emails/batch-email",
|
|
"api-reference/emails/update-schedule",
|
|
"api-reference/emails/cancel-schedule"
|
|
]
|
|
},
|
|
{
|
|
"group": "Contact Books",
|
|
"pages": [
|
|
"api-reference/contacts/list-contact-books",
|
|
"api-reference/contacts/get-contact-book",
|
|
"api-reference/contacts/create-contact-book",
|
|
"api-reference/contacts/update-contact-book",
|
|
"api-reference/contacts/delete-contact-book"
|
|
]
|
|
},
|
|
{
|
|
"group": "Contacts",
|
|
"pages": [
|
|
"api-reference/contacts/get-contact",
|
|
"api-reference/contacts/get-contacts",
|
|
"api-reference/contacts/create-contact",
|
|
"api-reference/contacts/bulk-create-contact",
|
|
"api-reference/contacts/update-contact",
|
|
"api-reference/contacts/upsert-contact",
|
|
"api-reference/contacts/delete-contact",
|
|
"api-reference/contacts/bulk-delete-contacts"
|
|
]
|
|
},
|
|
{
|
|
"group": "Domains",
|
|
"pages": [
|
|
"api-reference/domains/get-domain",
|
|
"api-reference/domains/list-domains",
|
|
"api-reference/domains/create-domain",
|
|
"api-reference/domains/verify-domain",
|
|
"api-reference/domains/delete-domain"
|
|
]
|
|
},
|
|
{
|
|
"group": "Campaigns",
|
|
"pages": [
|
|
"api-reference/campaigns/create-campaign",
|
|
"api-reference/campaigns/get-campaigns",
|
|
"api-reference/campaigns/get-campaign",
|
|
"api-reference/campaigns/schedule-campaign",
|
|
"api-reference/campaigns/pause-campaign",
|
|
"api-reference/campaigns/resume-campaign",
|
|
"api-reference/campaigns/delete-campaign"
|
|
]
|
|
},
|
|
{
|
|
"group": "Analytics",
|
|
"pages": [
|
|
"api-reference/analytics/email-time-series",
|
|
"api-reference/analytics/reputation-metrics"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"global": {
|
|
"anchors": [
|
|
{
|
|
"anchor": "Source code",
|
|
"href": "https://github.com/caelum0x/scribase-mail-studio",
|
|
"icon": "github"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"logo": {
|
|
"light": "/logo/logo-wordmark.svg",
|
|
"dark": "/logo/logo-wordmark-dark.svg"
|
|
},
|
|
"api": {
|
|
"playground": {
|
|
"display": "interactive"
|
|
},
|
|
"mdx": {
|
|
"server": "https://mintlify.com/api",
|
|
"auth": {
|
|
"method": "bearer"
|
|
}
|
|
}
|
|
},
|
|
"navbar": {
|
|
"links": [
|
|
{
|
|
"label": "Support",
|
|
"href": "mailto:hello@scribase.com"
|
|
}
|
|
],
|
|
"primary": {
|
|
"type": "button",
|
|
"label": "Dashboard",
|
|
"href": "https://mail.scribase.com"
|
|
}
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"github": "https://github.com/caelum0x/scribase-mail-studio"
|
|
}
|
|
},
|
|
"contextual": {
|
|
"options": [
|
|
"copy",
|
|
"view",
|
|
"chatgpt",
|
|
"claude",
|
|
"perplexity"
|
|
]
|
|
}
|
|
}
|