Moxie CRM MCP服务器
 ](https://nodejs.org/) 
MCP(模型上下文协议)服务器,使LLM能够与 莫西CRM。提供用于管理客户、联系人、项目、发票、时间跟踪等的全面工具。
特性
- 客户管理:列出、搜索和创建具有完整联系信息的客户
- 联系人管理:搜索并创建与客户关联的联系人
- 项目管理:搜索项目、创建/更新项目和管理任务阶段
- 任务管理:创建具有子任务、自定义字段和多受让人支持的任务
- 发票操作:搜索发票、创建新发票和应用付款
- 时间追踪:创建时间条目,可选择自动创建客户/项目
- 支出追踪:记录和分类业务费用
- 销售渠道:创造机会并管理管道阶段
- 支持票:使用结构化表单数据创建工单并添加注释
- 日历事件:创建、更新和删除日历事件
- 表格提交:提交潜在客户捕获表,并创建渠道机会
- 文件附件:将URL中的文件附加到各种实体
- 模板:访问电子邮件和发票模板、供应商名称和工作区用户
快速开始
克隆和构建
git clone https://github.com/flyingwebie/withmoxie-mcp-server.git
cd withmoxie-mcp-server
npm install
npm run build
获取API密钥
- 登录您的 勇气 账户
- 导航到 工作区设置 → 已连接的应用程序 → 集成
- 点击 启用自定义集成
- 复制您的 API密钥 和 基本端点URL
IDE集成指南
克劳德代码
增添 ~/.claude/claude_desktop_config.json:
{
"mcpServers": {
"moxie": {
"command": "npx",
"args": ["-y", "withmoxie-mcp-server"],
"env": {
"MOXIE_BASE_URL": "https://pod01.withmoxie.com/api/public",
"MOXIE_API_KEY": "your_api_key_here"
}
}
}
}
克劳德桌面
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json 视窗: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"moxie": {
"command": "npx",
"args": ["-y", "withmoxie-mcp-server"],
"env": {
"MOXIE_BASE_URL": "https://pod01.withmoxie.com/api/public",
"MOXIE_API_KEY": "your_api_key_here"
}
}
}
}
光标
增添 .cursor/mcp.json 在项目根目录中:
{
"mcpServers": {
"moxie": {
"command": "npx",
"args": ["-y", "withmoxie-mcp-server"],
"env": {
"MOXIE_BASE_URL": "https://pod01.withmoxie.com/api/public",
"MOXIE_API_KEY": "your_api_key_here"
}
}
}
}
带有Cline扩展的VS代码
添加到您的VS代码 settings.json:
{
"cline.mcpServers": {
"moxie": {
"command": "npx",
"args": ["-y", "withmoxie-mcp-server"],
"env": {
"MOXIE_BASE_URL": "https://pod01.withmoxie.com/api/public",
"MOXIE_API_KEY": "your_api_key_here"
}
}
}
}
帆板运动
添加到您的Windsurf MCP配置中:
{
"mcpServers": {
"moxie": {
"command": "npx",
"args": ["-y", "withmoxie-mcp-server"],
"env": {
"MOXIE_BASE_URL": "https://pod01.withmoxie.com/api/public",
"MOXIE_API_KEY": "your_api_key_here"
}
}
}
}
MCP检验员(测试)
MOXIE_API_KEY=your_key MOXIE_BASE_URL=https://pod01.withmoxie.com/api/public npx @modelcontextprotocol/inspector npx -y withmoxie-mcp-server
示例提示
配置后,您可以使用自然语言与Moxie交互:
管理客户
“列出我的所有客户”
“搜索名为‘Acme’的客户”
“用美元创建一个名为‘Tech Startup Inc’的新客户”
管理联系人
“搜索电子邮件中包含'john'的联系人”
“将新联系人Jane Smith添加到客户‘Acme Corp’”
项目运营
“显示客户端“Web代理”的所有项目”
“为客户‘Tech Startup Inc’创建一个名为‘网站重新设计’的新项目”
“有哪些可用的任务阶段?”
发票管理
“搜索未付发票”
“为‘Acme Corp’开具发票,其中包含10小时咨询的行项目,每小时150美元”
“向发票ID abc123支付500美元”
时间追踪
“从今天上午9点到11点,为用户的“网站重新设计”项目记录2小时的工作john@company.com"
“为客户‘Acme Corp’创建一个时间条目,如果不存在,则自动创建项目”
支出追踪
“从今天开始,记录‘办公用品’的50美元支出”
“为客户‘Tech Startup Inc’创建200美元的软件订阅费用”
销售渠道
“列出所有管道阶段”
“创造一个价值5万美元的名为‘企业交易’的新机会”
任务管理
在“网站重新设计”项目中为客户“Acme Corp”创建一个名为“设计主页”的任务,其中包含子任务“页眉”、“页脚”、“英雄部分”
支持票
“为联系人创建支持票john@acme.com票证类型为“支持请求”,注释为“登录页面已损坏”
“在票证ID xyz789中添加注释”
日历事件
“明天下午2点至3点创建一个名为“项目启动”的会议”
“更新日历事件以将位置更改为“会议室A””
模板和设置
“列出所有电子邮件模板”
“显示可用的发票模板”
“我的工作区中的用户是谁?”
可用工具
客户端工具(3)
| 工具 | 说明 |
|---|
list_clients | 列出Moxie工作区中的所有客户 |
search_clients | 按姓名或联系方式搜索客户 |
create_client | 使用联系人和付款条件创建新客户 |
接触工具(2)
| 工具 | 说明 |
|---|
search_contacts | 按姓名、电子邮件或电话搜索联系人 |
create_contact | 创建与客户关联的新联系人 |
项目工具(4)
| 工具 | 说明 |
|---|
search_projects | 搜索项目,可选择按客户筛选 |
create_project | 为客户创建新项目 |
update_project | 更新现有项目的详细信息 |
list_project_task_stages | 列出所有可用的任务阶段 |
发票工具(3)
| 工具 | 说明 |
|---|
search_payable_invoices | 在工作区中搜索发票 |
create_invoice | 使用行项目创建新发票 |
apply_payment | 将付款应用于现有发票 |
任务工具(1)
| 工具 | 说明 |
|---|
create_task | 创建具有子任务、多受让人、自定义字段和数字优先级的任务 |
时间输入工具(1)
| 工具 | 说明 |
|---|
create_time_entry | 使用可选的自动创建功能创建时间条目 |
费用工具(1)
| 工具 | 说明 |
|---|
create_expense | 创建新的支出记录 |
机会工具(2)
| 工具 | 说明 |
|---|
list_pipeline_stages | 列出所有管道阶段的机会 |
create_opportunity | 创造新的销售机会 |
票务工具(2)
| 工具 | 说明 |
|---|
create_ticket | 创建工单(需要联系电子邮件、工单类型和评论) |
create_ticket_comment | 向现有工单添加注释 |
表单工具(2)
| 工具 | 说明 |
|---|
list_form_names | 列出所有可用表格 |
create_form_submission | 提交一份潜在客户捕获表,其中包含可选的渠道机会创建 |
文件工具(1)
| 工具 | 说明 |
|---|
attach_file_from_url | 将URL中的文件附加到Moxie记录 |
日历工具(3)
| 工具 | 说明 |
|---|
create_calendar_event | 创建新的日历事件 |
update_calendar_event | 更新现有日历事件 |
delete_calendar_event | 删除日历事件 |
可交付工具(1)
| 工具 | 说明 |
|---|
approve_deliverable | 批准项目中的可交付成果/任务 |
模板和参考工具(4)
| 工具 | 说明 |
|---|
list_email_templates | 列出所有电子邮件模板 |
list_invoice_templates | 列出所有发票模板 |
list_vendor_names | 列出所有供应商的费用名称 |
list_workspace_users | 列出工作区中的所有用户 |
配置
| 变量 | 必填 | 描述 |
|---|
MOXIE_API_KEY | 是 | 您的莫西API密钥 |
MOXIE_BASE_URL | 是 | 您的Moxie API基础URL(例如。, https://pod01.withmoxie.com/api/public) |
查找您的基本URL
您的基本URL取决于您的工作区所在的Moxie pod。当您在Moxie中启用自定义集成时,您将看到您的特定基本URL。常见格式:
https://pod01.withmoxie.com/api/publichttps://pod00.withmoxie.dev/api/public
发展
# Install dependencies
npm install
# Build
npm run build
# Development mode (watch)
npm run dev
# Test with MCP Inspector
MOXIE_API_KEY=your_key MOXIE_BASE_URL=your_url npx @modelcontextprotocol/inspector npx -y withmoxie-mcp-server
项目结构
withmoxie-mcp-server/
├── src/
│ ├── index.ts # Server entry point
│ ├── server.ts # MCP server setup
│ ├── client/
│ │ └── moxie-client.ts # API client with auth
│ ├── types/
│ │ └── moxie.ts # TypeScript interfaces
│ └── tools/
│ ├── index.ts # Tool registration
│ ├── clients.ts # Client tools
│ ├── contacts.ts # Contact tools
│ ├── projects.ts # Project tools
│ ├── invoices.ts # Invoice tools
│ ├── tasks.ts # Task tools
│ ├── time-entries.ts # Time entry tools
│ ├── expenses.ts # Expense tools
│ ├── opportunities.ts # Opportunity tools
│ ├── tickets.ts # Ticket tools
│ ├── forms.ts # Form tools
│ ├── files.ts # File tools
│ ├── calendar.ts # Calendar tools
│ ├── deliverables.ts # Deliverable tools
│ └── templates.ts # Template tools
├── build/ # Compiled JavaScript
├── package.json
├── tsconfig.json
└── README.md
API费率限制
Moxie的速率限制为 每5分钟100个请求。如果超过,您将收到HTTP 429响应。发生这种情况时,服务器将返回一条有用的错误消息。
错误处理
服务器为常见问题提供可操作的错误消息:
| 代码 | 描述 | 解决方案 |
|---|
| 401 | 未经授权 | 检查您的 MOXIE_API_KEY |
| 404 | 找不到资源 | 验证资源是否存在(需要与名称完全匹配) |
| 429 | 超出速率限制 | 等待并重试(每5分钟100个请求) |
重要提示
- 精确名称匹配:许多Moxie API端点要求客户端、项目、模板、票证类型和管道阶段的名称完全匹配。确保使用Moxie中出现的确切名称。
- 发票草案:创建没有发票的发票时
sendTo 参数,发票以草稿状态创建。 - 自动创建:时间条目支持通过布尔标志自动创建客户端、项目和可交付成果。
- 门票需要联系电子邮件:The
create_ticket 工具需要 userEmail 成为您工作区中的现有联系人。如果找不到电子邮件,门票将被拒绝。 - 表单提交创造机会:使用
create_form_submission 随着 pipelineStageName 从潜在客户数据中自动创建渠道机会。 - 推测终点:The
create_opportunity 和 update_project 工具使用遵循Moxie API约定但可能没有正式文档的端点。在您的工作空间中测试它们。
已知限制
- 无任务/可交付成果清单:Moxie Public API不公开任何端点来列出、搜索或检索项目的任务(可交付成果)。任务只能是 创建 (
create_task)以及 批准 (approve_deliverable),但不能通过API读回。 - 项目中的可交付成果为空:The
deliverables 返回的数组 search_projects 按设计总是空的-Moxie不会在API响应中填充它。 - 仅通过Webhooks获取任务数据:要跟踪任务更改,请使用Moxie的webhook事件(
DeliverableCreate, DeliverableUpdate, DeliverableDelete)其包括全部任务有效载荷。
许可证
麻省理工学院