Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion cli/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: "CLI"
description: "Install and configure the Sendmux CLI for management, mailbox, and sending workflows."

Check warning on line 3 in cli/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

cli/index.mdx#L3

Did you really mean 'Sendmux'?
keywords:
[
"Sendmux CLI",
"@sendmux/cli",
"sendmux",
"Homebrew",
"profiles",
"Management API",
"Mailbox API",
Expand All @@ -13,7 +14,7 @@
]
---

Use the `sendmux` CLI when you want terminal access to the same Management, Mailbox, and Sending API surfaces exposed by the SDKs.

Check warning on line 17 in cli/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

cli/index.mdx#L17

Did you really mean 'SDKs'?

<Info>
Sending and Mailbox commands require mailbox-scoped `smx_mbx_` keys.
Expand All @@ -22,7 +23,13 @@

## Install

Install the CLI from npm.
Install the CLI with Homebrew on macOS or Linux.

```bash
brew install sendmux/tap/sendmux

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Point Homebrew install at a published formula

Homebrew's direct install form brew install user/repository/formula only works when the tapped repo contains a matching formula file, and Homebrew documents Formula/, HomebrewFormula/, or the repo root as valid formula locations. I checked the public sendmux/homebrew-tap repository that this shorthand resolves to and it currently has no sendmux.rb formula, so this new primary install command will fail before users reach the npm fallback. Please publish the formula or keep npm as the documented install path until the tap is populated.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chatgpt-codex-connector False positive for the intended merge order — the formula is staged in Sendmux/homebrew-tap#1, and I added that dependency to the docs PR body so this docs PR merges after the tap is published.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

```

You can also install it from npm.

```bash
npm install -g @sendmux/cli
Expand Down
2 changes: 1 addition & 1 deletion guides/mcp.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "MCP"
description: "Connect AI tools to Sendmux documentation and product tools."

Check warning on line 3 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L3

Did you really mean 'Sendmux'?
keywords:
[
"MCP",
Expand All @@ -11,16 +11,16 @@
]
---

Sendmux has two MCP connections. Use Documentation MCP when you want an AI tool to search Sendmux docs. Use Product MCP when you want an agent to work with Sendmux tools you authorise.

Check warning on line 14 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L14

Did you really mean 'Sendmux'?

Check warning on line 14 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L14

Did you really mean 'Sendmux'?

Check warning on line 14 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L14

Did you really mean 'Sendmux'?

| Connection | Use it for | Server |
| --- | --- | --- |
| Documentation MCP | Search Sendmux guides and API references. | `https://sendmux.ai/docs/mcp` |

Check warning on line 18 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L18

Did you really mean 'Sendmux'?
| Product MCP | Use Management, Mailbox, and Sending tools. | `https://mcp.sendmux.ai/mcp` or the local `sendmux-mcp` package |

<Info>
Product MCP exposes a curated agent toolset, not every API endpoint. Use the

Check warning on line 22 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L22

Did you really mean 'toolset'?
SDKs, CLI, or API reference when you need full endpoint coverage.

Check warning on line 23 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L23

Did you really mean 'SDKs'?
</Info>

## Documentation MCP
Expand All @@ -30,7 +30,7 @@
<AccordionGroup>
<Accordion title="Claude Code" description="Add the docs server over HTTP.">
```bash
claude mcp add sendmux-docs --transport http https://sendmux.ai/docs/mcp

Check warning on line 33 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L33

Did you really mean 'claude'?

Check warning on line 33 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L33

Did you really mean 'mcp'?
```
</Accordion>

Expand Down Expand Up @@ -83,7 +83,7 @@
| Management | Manage team resources such as domains, mailboxes, sending accounts, logs, metrics, billing, and webhooks. | Hosted grant with Management access, or an `smx_root_` key locally |
| Sending | Send single or batch emails. | Hosted grant with Sending access, or an `smx_mbx_` key locally |

Hosted Product MCP is the default when your client supports remote MCP with browser OAuth. It keeps Sendmux in the authorisation flow, avoids distributing manual API keys to agents, and shows only the tools allowed by the grant.

Check warning on line 86 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L86

Did you really mean 'Sendmux'?

| Setting | Value |
| --- | --- |
Expand All @@ -91,7 +91,7 @@
| Authorisation server | `https://app.sendmux.ai` |
| Health check | `https://mcp.sendmux.ai/health` |

When you connect, Sendmux asks you to choose a team, product surfaces, and mailbox access where relevant. Access tokens are short-lived. Refresh tokens rotate on use and can last up to 30 days unless the connection is disconnected or expires.

Check warning on line 94 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L94

Did you really mean 'Sendmux'?

<Note>
If you grant more than one mailbox, start mailbox workflows with
Expand Down Expand Up @@ -178,9 +178,9 @@
```bash
sendmux-mcp \
--surfaces mailbox,management,sending \
--mailbox-api-key smx_mbx_... \

Check warning on line 181 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L181

Did you really mean 'smx_mbx_'?
--management-api-key smx_root_... \

Check warning on line 182 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L182

Did you really mean 'smx_root_'?
--sending-api-key smx_mbx_...

Check warning on line 183 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L183

Did you really mean 'smx_mbx_'?
```
</Accordion>
</AccordionGroup>
Expand Down Expand Up @@ -221,13 +221,13 @@

<CardGroup cols={2}>
<Card title="MCP clients" icon="plug" href="/guides/mcp-clients">
Configure Sendmux MCP in Claude Code, Cursor, Codex, Gemini CLI, Qwen Code, Zed, and more.

Check warning on line 224 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L224

Did you really mean 'Sendmux'?

Check warning on line 224 in guides/mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

guides/mcp.mdx#L224

Did you really mean 'Qwen'?
</Card>
<Card title="SDKs" icon="code" href="/sdks">
Use package-managed clients from application code.
</Card>
<Card title="CLI" icon="terminal" href="/cli">
Run the same product surfaces from your terminal.
Install the CLI with Homebrew or npm when you need terminal access.
</Card>
<Card title="API keys" icon="key" href="/guides/api-keys">
Create scoped credentials for local MCP setups.
Expand Down
2 changes: 1 addition & 1 deletion sdks/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "SDKs"

Check warning on line 2 in sdks/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

sdks/index.mdx#L2

Did you really mean 'SDKs'?
sidebarTitle: "Overview"
description: "Choose a Sendmux SDK package and the API surface it should use."

Check warning on line 4 in sdks/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

sdks/index.mdx#L4

Did you really mean 'Sendmux'?
keywords:
[
"SDKs",
Expand All @@ -16,12 +16,12 @@
]
---

Sendmux SDKs give your application package-managed clients for the Sending, Mailbox, and Management APIs.

Check warning on line 19 in sdks/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

sdks/index.mdx#L19

Did you really mean 'Sendmux'?

Check warning on line 19 in sdks/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

sdks/index.mdx#L19

Did you really mean 'SDKs'?

Use an umbrella package when one application needs more than one API surface. Use a surface package when you want a smaller dependency for one job.

<Info>
Create the API key in Sendmux before you install a package. Sending and

Check warning on line 24 in sdks/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

sdks/index.mdx#L24

Did you really mean 'Sendmux'?
Mailbox clients use mailbox-scoped `smx_mbx_` keys. Management clients use
team-scoped `smx_root_` keys.
</Info>
Expand All @@ -40,7 +40,7 @@
| --- | --- | --- |
| TypeScript | `@sendmux/sdk` | `@sendmux/sending`, `@sendmux/mailbox`, `@sendmux/management` |
| Python | `sendmux-sdk` | `sendmux-sending`, `sendmux-mailbox`, `sendmux-management` |
| Go | `sendmux.ai/go` | `sending`, `mailbox`, `management`, and `sdk` subpackages |

Check warning on line 43 in sdks/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

sdks/index.mdx#L43

Did you really mean 'subpackages'?
| PHP | `sendmux/sdk` | `sendmux/sending`, `sendmux/mailbox`, `sendmux/management` |
| Ruby | `sendmux-sdk` | `sendmux-sending`, `sendmux-mailbox`, `sendmux-management` |

Expand All @@ -48,10 +48,10 @@

<CardGroup cols={2}>
<Card title="CLI" icon="terminal" href="/cli">
Run Sendmux management, mailbox, and sending commands from your terminal.
Install the Sendmux CLI with Homebrew or npm for terminal workflows.

Check warning on line 51 in sdks/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

sdks/index.mdx#L51

Did you really mean 'Sendmux'?
</Card>
<Card title="MCP servers" icon="plug" href="/guides/mcp">
Connect AI tools to Sendmux docs and authorised product tools.

Check warning on line 54 in sdks/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (sendmux) - vale-spellcheck

sdks/index.mdx#L54

Did you really mean 'Sendmux'?
</Card>
</CardGroup>

Expand Down