使用说明
项目简介
本项目 'Signaturit MCP Server' 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在将 Signaturit API 的功能以标准化的方式提供给大型语言模型 (LLM) 客户端。通过此服务器,LLM 应用可以安全、可扩展地访问 Signaturit 的数字签名和联系人管理服务。
主要功能点
- 签名管理工具:
- 'get_signature': 查询指定ID的签署请求详情。
- 'create_signature': 使用模板创建新的签署请求,支持多人签署、邮件/短信发送、自定义过期时间、顺序/并行签署流程、自定义消息和Webhook集成。
- 'send_signature_reminder': 向待签署人发送签署提醒。
- 'cancel_signature': 取消正在进行的签署请求。
- 联系人管理工具:
- 'list_contacts': 获取Signaturit账户中的所有联系人列表。
- 'get_contact': 根据ID获取单个联系人信息。
- 'create_contact': 创建新的联系人。
- 'update_contact': 更新现有联系人信息。
- 'delete_contact': 删除联系人。
安装步骤
-
安装 Go 环境: 确保已安装 Go 1.16 或更高版本。
- 访问 Go 官网 下载并安装。
- 在终端运行 'go version' 验证安装是否成功。
-
获取 Signaturit API 密钥:
- 访问 Signaturit 官网 创建账户。
- 登录后在仪表板中获取 API 密钥。
-
克隆仓库:
git clone https://github.com/jmartin82/signaturit-mcp.git cd signaturit-mcp -
安装依赖:
go mod download -
编译项目:
go build -o bin/signaturit_mcp cmd/server/main.go
服务器配置
MCP 客户端需要配置以下信息以连接到 'Signaturit MCP Server':
{ "serverName": "signaturit-mcp-server", "command": "./bin/signaturit_mcp", "args": [], "env": { "SIGNATURIT_SECRET_TOKEN": "<Your_Signaturit_API_Key>" // 请将 <Your_Signaturit_API_Key> 替换为您的 Signaturit API 密钥 // API 密钥也可以在运行服务器之前通过 export 命令设置到环境变量中,例如: // export SIGNATURIT_SECRET_TOKEN='your_api_key_here' } }
配置说明:
- 'serverName': 服务器名称,可以自定义。
- 'command': MCP 服务器的启动命令,指向编译生成的可执行文件路径 './bin/signaturit_mcp'。
- 'args': 启动参数,本项目无需额外启动参数,保持为空数组 '[]' 即可。
- 'env': 环境变量配置。
- 'SIGNATURIT_SECRET_TOKEN': 必须配置。用于 Signaturit API 鉴权的密钥,请替换为您的实际 API 密钥。
基本使用方法
-
启动服务器: 在终端中,确保已设置 'SIGNATURIT_SECRET_TOKEN' 环境变量,然后运行编译生成的可执行文件:
./bin/signaturit_mcp服务器默认通过标准输入/输出 (stdio) 与 MCP 客户端通信。
-
MCP 客户端调用: 配置 MCP 客户端连接到上述配置的 'Signaturit MCP Server'。客户端可以使用服务器提供的工具 (Tools) 来管理 Signaturit 的签名和联系人,例如调用 'create_signature' 工具创建新的签署请求。
具体的工具调用方法和参数,请参考各个工具的详细描述(例如 'create_signature' 工具需要 'templates' 和 'recipients' 参数)。
信息
分类
商业系统