Signaturit

🚀 Signaturit MCP 服務端簽名 ✍️

本項目演示了一個 MCP（微服務通信協議）服務器如何通過 Signaturit 工具的公共 API 進行整合，提供了多種功能來管理簽名請求，包括列表、創建和處理簽名。

⚠️ 重要提示

這是一個非官方集成項目，與 Signaturit 無任何關聯、無正式維護或支持。

🚀 快速開始

若要使用本項目，你需要完成以下步驟：

1. 確保滿足先決條件，包括安裝 Go 1.16 或更高版本，以及在 Signaturit 擁有活動賬戶並獲取有效的 API 密鑰。
2. 進行 API 認證，將 API 密鑰設置為環境變量。
3. 克隆倉庫、安裝依賴項、構建應用程序並運行。

✨ 主要特性

MCP 服務器提供以下工具與 Signaturit 交互：

• get_signature 📄：使用簽名請求 ID 獲取特定簽名請求的詳細信息。
• create_signature ✨：使用模板創建新的簽名請求。
  • 支持多個簽署人 👥。
  • 通過電子郵件或短信發送 📧 📱。
  • 可自定義的過期時間 ⏰。
  • 串行或並行簽署流程 ⛓️。
  • 自定義電子郵件/短信消息 💬。
  • 網鉤集成以實現即時通知 🔔。
• send_signature_reminder 📬：發送提醒通知給待處理的簽署人。
• cancel_signature ❌：取消活動簽名請求並可自選原因。

📦 安裝指南

先決條件 📋

1. Go 安裝
   • Go 1.16 或更高版本。
   • 驗證安裝：

     go version
     

2. Signaturit 賬戶
   • 在 Signaturit 擁有活動賬戶。
   • 有效的 API 密鑰，從 Signaturit 儀表盤獲取。

API 認證 🔐

此服務器與 Signaturit API 集成，需要一個 API 密鑰進行身份驗證。您需要：

1. 在 Signaturit 創建賬戶。
2. 從 Signaturit 儀表盤獲取您的 API 密鑰。
3. 將 API 密鑰設置為環境變量：

export SIGNATURIT_SECRET_TOKEN='your_api_key_here'

構建 🔨

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

除非適用法律要求或書面協議另有約定，否則軟件
在本許可下分發是按“原樣”提供的，不附帶任何形式的擔保或其他條件。

有關具體條款，請參閱許可證中指定的語言。