Odichat

mcp-odichat

一个 Model Context Protocol（MCP）服务，将完整的 Odichat API（包括 Odichat 独有功能）作为 123 个工具提供给 Claude、ChatGPT、VS Code Copilot 等 AI 助手使用。

功能

• 123 个工具，涵盖所有 Odichat API 端点
• 账户、Agent、联系人、对话、消息、收件箱、团队等
• 报告（v1 和 v2）、帮助中心、自动化规则、自定义属性、自定义筛选器
• Odichat 独有：看板、看板步骤、看板任务、看板审计事件、定时消息
• 正确的 MCP 工具注释（readOnlyHint、destructiveHint、idempotentHint）
• 支持多个账户（account_id 是每个工具的参数）
• 两种传输方式：
  • stdio — 本地子进程（Claude Desktop、VS Code 及任何 MCP 客户端）
  • Streamable HTTP — 远程托管服务（Claude Web/Desktop/Code、ChatGPT）。无状态；API 令牌通过每个请求的 ?token= 查询参数传递

要求

• Bun v1.0+
• 可访问 API 的 Odichat 实例

安装

bun install

环境变量

变量	必需	说明
ODICHAT_API_TOKEN	仅 stdio	API 访问令牌（可在 Odichat → 个人资料 → 访问令牌中找到）。HTTP 传输方式不使用此变量。
MCP_TRANSPORT	否	设置为 http 以作为网络服务运行。其他任何值（或未设置）均使用 stdio。
PORT	否	HTTP 传输方式使用的端口。默认为 3000。

在 HTTP 模式下，令牌不会从环境变量读取——每个客户端通过 ?token= 查询参数提供自己的令牌，从而使服务保持无状态并支持多租户。

用法

开发

bun run dev

生产环境（stdio）

bun run start

生产环境（远程 HTTP 服务）

使用 Bun.serve() 和符合 Web 标准的 Streamable HTTP 传输方式，通过 HTTP 运行服务：

MCP_TRANSPORT=http PORT=3000 bun run src/index.ts

也可以使用 Docker：

docker build -t mcp-odichat .
docker run -p 3000:3000 mcp-odichat

该服务是无状态的——没有数据库，也没有会话。每个请求都必须在 ?token= 查询参数中包含调用方的 Odichat API 令牌。SSL 应由上游代理（例如 Traefik）终止。

端点：

方法	路径	说明
POST/GET	/mcp	MCP Streamable HTTP 端点
GET	/health	健康检查（返回 ok）

连接到托管服务

将支持远程 MCP 的客户端（Claude Web/Desktop/Code、ChatGPT）指向服务 URL，并在查询字符串中附上令牌：

https://mcp.odichat.app/mcp?token=YOUR_API_TOKEN

1. 在 Odichat 中，前往个人资料 → 访问令牌并复制令牌。
2. 将上面的 URL（附带令牌）作为 MCP 服务 URL 添加到 AI 客户端中。

本地（stdio）客户端配置

Claude Desktop 配置

将以下内容添加到 claude_desktop_config.json：

{
  "mcpServers": {
    "odichat": {
      "command": "bun",
      "args": ["run", "/path/to/mcp-odichat/src/index.ts"],
      "env": {
        "ODICHAT_API_TOKEN": "your-api-token"
      }
    }
  }
}

VS Code 配置

将以下内容添加到 .vscode/mcp.json：

{
  "servers": {
    "odichat": {
      "command": "bun",
      "args": ["run", "${workspaceFolder}/src/index.ts"],
      "env": {
        "ODICHAT_API_TOKEN": "your-api-token"
      }
    }
  }
}

ChatGPT 配置

ChatGPT 通过 HTTP 连接到远程 MCP 服务——请参阅上文的连接到托管服务。

可用工具（123 个）

账户（2 个）

account_get、account_update

Agent 机器人（5 个）

agent_bots_list、agent_bots_create、agent_bots_get、agent_bots_update、agent_bots_delete

Agent（4 个）

agents_list、agents_create、agents_update、agents_delete

审计日志（1 个）

audit_logs_list

自动化规则（5 个）

automation_rules_list、automation_rules_create、automation_rules_get、automation_rules_update、automation_rules_delete

Canned Responses (4)

canned_responses_list, canned_responses_create, canned_responses_update, canned_responses_delete

Contacts (11)

contacts_list, contacts_create, contacts_get, contacts_update, contacts_delete, contacts_conversations, contacts_search, contacts_filter, contacts_create_contact_inbox, contacts_contactable_inboxes, contacts_merge

Contact Labels (2)

contact_labels_list, contact_labels_set

Conversations (12)

conversations_meta, conversations_list, conversations_create, conversations_filter, conversations_get, conversations_update, conversations_toggle_status, conversations_toggle_priority, conversations_set_custom_attributes, conversations_get_labels, conversations_set_labels, conversations_reporting_events

Conversation Assignments (1)

conversation_assignments_assign

Messages (3)

messages_list, messages_create, messages_delete

Custom Attributes (5)

custom_attributes_list, custom_attributes_create, custom_attributes_get, custom_attributes_update, custom_attributes_delete

Custom Filters (5)

custom_filters_list, custom_filters_create, custom_filters_get, custom_filters_update, custom_filters_delete

Help Center (5)

help_center_portals_list, help_center_portals_create, help_center_portals_update, help_center_categories_create, help_center_articles_create

Inboxes (10)

inboxes_list, inboxes_get, inboxes_create, inboxes_update, inboxes_get_agent_bot, inboxes_set_agent_bot, inbox_members_list, inbox_members_create, inbox_members_update, inbox_members_delete

Integrations (4)

integrations_list_apps, integrations_create_hook, integrations_update_hook, integrations_delete_hook

Profile (1)

profile_get

Reports (9)

reports_account_overview, reports_account_summary, reports_agent_summary, reports_conversation_metrics, reports_v2_overview, reports_v2_agents, reports_v2_inboxes, reports_v2_teams, reports_v2_labels

Teams (9)

teams_list, teams_create, teams_get, teams_update, teams_delete, team_members_list, team_members_add, team_members_update, team_members_delete

Webhooks (4)

webhooks_list, webhooks_create, webhooks_update, webhooks_delete

Kanban Boards (6) — [Odichat]

kanban_boards_list, kanban_boards_create, kanban_boards_get, kanban_boards_update, kanban_boards_delete, kanban_boards_update_agents

Kanban Steps (5) — [Odichat]

kanban_steps_list, kanban_steps_create, kanban_steps_get, kanban_steps_update, kanban_steps_delete

Kanban Tasks (6) — [Odichat]

kanban_tasks_list, kanban_tasks_create, kanban_tasks_get, kanban_tasks_update, kanban_tasks_delete, kanban_tasks_move

Kanban Audit Events (2) — [Odichat]

kanban_audit_events_list, kanban_audit_events_get

Scheduled Messages (4) — [Odichat]

scheduled_messages_list, scheduled_messages_create, scheduled_messages_update, scheduled_messages_delete

Development

# Run tests
bun test

# Lint & format
bun run lint
bun run format

# Type check
bun run build-check

# Full check (lint + type-check + tests)
bun run check

License

MIT