Offorte MCP Server

🚀 Offorte MCP 服务器

Offorte 的 MCP 服务器可借助人工智能创建并发送提案。它充当人工智能代理与 Offorte 提案引擎之间的桥梁，使外部模型能够通过 Offorte 创建并发送提案。专为自动化工作流程而构建的 MCP 可轻松将提案操作集成到人工智能工具、聊天界面和自主系统中。

⚠️ 重要提示

请注意，MCP（模型上下文协议）是一种全新的人工智能集成方法。虽然功能强大，但它仍在不断发展，偶尔可能会产生意外或不理想的结果。

🚀 快速开始

项目背景

本项目旨在借助协议利用人工智能创建并发送提案。由于该项目处于实验阶段，因此并未涵盖完整的 Offorte API，仅包含创建和发送提案所需的工具。目前尚未实现可能导致大语言模型更新和删除内容的工具。未来，我们将根据实际使用效果和用户反馈，考虑添加更新和删除命令。

前置条件

• Node.js（已在 Node.js 20.x.x 版本上进行测试）
• Offorte API 密钥（请参阅 Offorte API 文档的 身份验证部分）
• 开发时需使用 PNPM
• TRANSPORT_TYPE（可选）：设置为 sse 可启用服务器发送事件（SSE）模式，不设置或使用默认值则为 stdio（默认值：stdio）。

开发步骤

若要开始开发，请克隆仓库并安装依赖项。确保你拥有 .env 文件，并包含正确的值。

git clone https://github.com/offorte/offorte-mcp-server.git
cd offorte-mcp-server
pnpm install
pnpm dev

命令说明

查看 NPM 脚本以了解所有命令，以下是最重要命令的简要总结：

✨ 主要特性

关于 Offorte

Offorte 是一款自动化提案软件，可帮助企业创建、发送和跟踪精美且交互式的提案。它专为速度、灵活性和实际应用而构建，在不牺牲个性化的前提下，将自动化与智能工作流程相结合。了解更多关于 Offorte 的信息。

API

MCP 服务器使用 Offorte 公共 API v2。如需了解更多信息，请阅读 API 文档。

演示

体验提案的未来：语音触发、人工智能驱动、完全自动化。查看 Offorte 如何在 此真实演示 中连接语音和工作流程。

📦 安装指南

目前文档未提及具体安装步骤相关内容，可参考开发步骤进行操作。

💻 使用示例

基础用法

目前文档未提供基础用法的代码示例。

高级用法

目前文档未提供高级用法的代码示例。

📚 详细文档

可用工具

上下文与设置

• get_initial_context – 重要提示：在使用任何其他工具之前，必须调用此工具以初始化上下文并获取使用说明。

账户

• get_users – 列出当前账户的所有用户。

自动化

• get_automation_sets – 列出用作创建新提案可选输入的自动化集。

联系人

• create_contact – 创建新联系人（组织或个人）。
• get_contact_details - 按 ID 获取联系人的所有详细信息。
• search_contact_organisations - 在联系人中按名称搜索组织。
• search_contact_people - 在联系人中按名称搜索人员。

收藏夹

• get_proposal_templates – 列出用作创建新提案起点的提案模板。

提案

• create_proposal – 创建新提案。
• get_proposal_directories – 按状态分组获取所有提案目录。
• search_proposals – 按查询条件搜索提案。
• send_proposal – 将提案发送给指定联系人。

设置

• get_design_templates – 列出用于创建新提案的可用设计模板。
• get_email_templates – 列出用于发送提案的可用电子邮件模板。
• get_text_templates – 列出用于创建新提案的可用语言文本模板。

MCP 客户端

目前，此 MCP 服务器仅在 Claude Desktop 上进行了测试。未来将添加更多客户端示例。

Claude Desktop 配置

在 Claude > 设置 > 开发者 > 编辑配置 中找到 claude_desktop_config.json，并根据你的需求添加以下 仅一项 配置：

NPX

直接从 npm 注册表运行。

{
    "mcpServers": {
        "offorte-proposals": {
            "command": "npx",
            "args": ["-y", "@offorte/mcp-server"],
            "env": {
                "OFFORTE_ACCOUNT_NAME": "<YOUR_ACCOUNT_NAME>",
                "OFFORTE_API_KEY": "<YOUR_TOKEN>"
            }
        }
    }
}

本地 Node

在使用此方法之前，应先安装依赖项并构建项目（pnpm install）。

{
    "mcpServers": {
        "offorte-proposals": {
            "command": "node",
            "args": ["/path/to/directory/offorte-mcp-server/dist/server.js"],
            "env": {
                "OFFORTE_ACCOUNT_NAME": "<YOUR_ACCOUNT_NAME>",
                "OFFORTE_API_KEY": "<YOUR_TOKEN>"
            }
        }
    }
}

🔧 技术细节

目前文档未提供具体技术细节相关内容。

📄 许可证

目前文档未提供许可证信息。