Signaturit

🚀 Signaturit MCP 服务端签名 ✍️

本项目演示了一个 MCP（微服务通信协议）服务器如何通过 Signaturit 工具的公共 API 进行整合，可提供多种功能来管理签名请求，包括列表、创建和处理签名。

⚠️ 重要提示

这是一个非官方集成项目，与 Signaturit 无任何关联、无正式维护或支持。

🚀 快速开始

本项目需要满足一定的先决条件，完成配置和构建后，即可运行 MCP 服务器。具体步骤如下：

1. 配置 API 认证：在 Signaturit 创建账户，获取 API 密钥，并将其设置为环境变量。
2. 满足先决条件：安装 Go 1.16 或更高版本，并在 Signaturit 拥有活动账户和有效的 API 密钥。
3. 构建项目：克隆仓库、安装依赖项、构建应用程序，并运行构建好的二进制文件。

具体操作请参考下文的“配置”、“先决条件”和“构建”部分。

✨ 主要特性

MCP 服务器提供以下工具与 Signaturit 交互：

• get_signature 📄：使用签名请求 ID 获取特定签名请求的详细信息。
• create_signature ✨：使用模板创建新的签名请求，具备以下特点：
  • 支持多个签署人 👥。
  • 通过电子邮件或短信发送 📧 📱。
  • 可自定义的过期时间 ⏰。
  • 串行或并行签署流程 ⛓️。
  • 自定义电子邮件/短信消息 💬。
  • 网钩集成以实现实时通知 🔔。
• send_signature_reminder 📬：发送提醒通知给待处理的签署人。
• cancel_signature ❌：取消活动签名请求并可自选原因。

📦 安装指南

配置 ⚙️

API 认证 🔐

此服务器与 Signaturit API 集成，需要一个 API 密钥进行身份验证。您需要：

1. 在 Signaturit 创建账户。
2. 从 Signaturit 仪表盘获取您的 API 密钥。
3. 将 API 密钥设置为环境变量：

export SIGNATURIT_SECRET_TOKEN='your_api_key_here'

先决条件 📋

1. Go 安装
   • Go 1.16 或更高版本。
   • 验证安装：

     go version
     

2. Signaturit 账户
   • 在 Signaturit 拥有活动账户。
   • 有效的 API 密钥，从 Signaturit 仪表盘获取。

构建 🔨

1. 克隆仓库

   git clone https://github.com/yourusername/signaturtit_mcp.git
   cd signaturtit_mcp
   

2. 安装依赖项

   go mod download
   

3. 构建应用程序

   # 为当前平台构建
   go build -o bin/signaturtit_mcp cmd/server/main.go
   
   # 为特定平台构建（例如 Linux）
   GOOS=linux GOARCH=amd64 go build -o bin/signaturtit_mcp cmd/server/main.go
   

4. 运行构建好的二进制文件

   # 确保您已经设置了所需的环境变量
   export SIGNATURIT_SECRET_TOKEN='your_api_key_here'
   
   # 运行应用程序
   ./bin/signaturtit_mcp
   

📚 详细文档

项目结构 📁

• cmd/server/main.go 🎯：应用程序入口。负责初始化并启动 MCP 服务器。
• internal/app/server.go ⚙️：包含创建和配置 MCP 服务器的逻辑，包括注册签名工具和服务处理。
• internal/handlers/signature.go 🛠️：实现各种签名操作（如列表、获取、管理）的处理程序。
• internal/tools/signature.go 🔧：将签名相关的工具注册到 MCP 服务器。

📄 许可证

版权 2024 Jordi Martin

根据 Apache 许可证 2.0（"许可证"）的条款，您可以在符合条件的情况下使用此文件；否则，不得使用该文件。

您可以从以下链接获取许可证：

    http://www.apache.org/licenses/LICENSE-2.0

除非适用法律要求或书面协议另有约定，否则软件
在本许可下分发是按“原样”提供的，不附带任何形式的担保或其他条件。

有关具体条款，请参阅许可证中指定的语言。