内容
# inkbox-mcp
Inkbox API 的模型上下文协议（MCP）服务器，允许 AI 代理管理电子邮件收件箱、电话号码、发送/接收短信和拨打电话，并安全地在加密保险箱中存储凭证。
## 前置条件
- **Node.js**: 版本 20.x 或更新。
- **Inkbox 账户和 API 密钥**：从 [Inkbox](https://inkbox.ai) 获取您的 API 密钥。
## 安装和设置
1. **克隆仓库或复制服务器文件** 到本地目录（例如 `/path/to/inkbox-mcp`）。
2. **安装依赖项**：
```bash
npm install
```
3. **构建服务器**：
```bash
npm run build
```
## 环境变量
| 变量名称 | 描述 | 是否必需 |
| --- | --- | --- |
| `INKBOX_API_KEY` | 您的 Inkbox 组织 API 密钥。 | 是 |
| `INKBOX_VAULT_KEY` | 您的组织级保险箱密钥。保险箱功能必需。 | 否（仅保险箱工具需要） |
## Claude 桌面配置
要将此服务器与 Claude Desktop 一起使用，请将以下配置添加到您的 `claude_desktop_config.json`（位于 Linux 上的 `~/.config/Claude/claude_desktop_config.json` 或 Windows 上的 `%APPDATA%\Claude\claude_desktop_config.json`）。
确保替换 `/absolute/path/to/inkbox-mcp` 为您的构建文件夹的实际路径，并提供您的 API 和保险箱密钥。
```json
{
"mcpServers": {
"inkbox-mcp": {
"command": "node",
"args": ["/absolute/path/to/inkbox-mcp/dist/index.js"],
"env": {
"INKBOX_API_KEY": "your_inkbox_api_key_here",
"INKBOX_VAULT_KEY": "your_inkbox_vault_key_here"
}
}
}
}
```
## 公开的 MCP 工具
| 组件 | 工具名称 | 描述 |
| --- | --- | --- |
| **身份** | `create_identity` | 创建一个新的 Inkbox 代理身份，包含可选的电子邮件、电话和隧道配置。 |
| **身份** | `get_identity` | 通过其句柄检索现有的代理身份。 |
| **身份** | `list_identities` | 列出您组织的 all 代理身份。 |
| **电子邮件** | `send_email` | 从身份的邮箱发送电子邮件。 |
| **电子邮件** | `list_emails` | 列出身份邮箱的电子邮件（最新的优先）。 |
| **电话** | `provision_phone_number` | 提供电话号码并将其链接到代理身份。 |
| **电话** | `send_text` | 从身份的电话号码发送短信/彩信。 |
| **电话** | `place_call` | 从身份拨打对外电话。 |
| **保险箱** | `create_secret` | 创建加密的保险箱秘密并授予代理身份访问权限。 |
| **保险箱** | `get_secret` | 获取身份有权访问的保险箱秘密并解密。 |
| **保险箱** | `list_secrets` | 列出身份可以访问的所有保险箱秘密的元数据（ID、名称、类型、描述、日期）。不包括有效载荷 - 请使用 `get_secret` 获取特定的解密有效载荷。 |
## 安全注意事项
当设置 `INKBOX_VAULT_KEY` 时，保险箱在服务器启动时解锁一次，并在整个进程生命周期中保持可解密。进程持有保险箱密钥在内存中，可以根据需要解密任何它有权访问的秘密。请将运行此服务器的主机视为 **受信任的环境** - 访问进程或其环境变量等同于访问保险箱。
如果您不需要保险箱功能，请完全省略 `INKBOX_VAULT_KEY`。保险箱工具将返回清晰的错误消息，而不是静默失败。
## 开发
在开发模式下运行编译：
```bash
npm run dev
```
## 测试
运行构建和烟雾测试套件：
```bash
npm test
```
## 持续集成
在 `.github/workflows/ci.yml` 中包含了一个 GitHub Actions 工作流。
它安装依赖项、构建项目，并在每次推送和拉取请求时运行烟雾测试。
