SignNow REST API 使开发者能够为签署人、准备人和发送人提供无缝的电子签名体验。您可以预填充文档、为多位签署人创建嵌入式品牌化工作流、请求付款并实时跟踪签名状态。确保在任何设备上都能简单、安全且直观地完成签名。

您可以使用 SignNow API 执行以下操作：

按角色顺序发送文档和文档组以进行签名
从文档创建可重用的模板
使用数据预填充文档字段
在签名流程中收集付款
将文档发送、签名或编辑体验嵌入到您的网站、应用程序或任何记录系统中
跟踪签名进度并下载已完成的文档

SignNow MCP 服务器

Name: SignNow MCP Server
Author: signnow

一个模型上下文协议 (MCP) 服务器，为 AI 代理提供对 SignNow 电子签名工作流（模板、嵌入式签名、邀请、状态跟踪和文档下载）的安全、结构化访问，支持 STDIO 或 可流式 HTTP。

mcp-name: io.github.signnow/sn-mcp-server

功能

模板与组
- 浏览所有模板和模板组
- 从模板创建文档或组（包含一次性流程）
邀请与嵌入式用户体验
- 电子邮件邀请和有序收件人
- 嵌入式签名/发送/编辑器链接，用于应用内体验
状态与检索
- 检查邀请状态和步骤详情
- 下载最终文档（单个或合并）
- 读取规范化的文档/组结构以进行程序化决策
传输方式
- STDIO（最适合本地客户端）
- 可流式 HTTP（最适合 Docker/远程）

快速入门

先决条件

SignNow 账户。创建一个免费开发者账户。
SignNow 凭据：您需要账户电子邮件、密码以及应用程序的基本授权令牌 (Basic Authorization Token)。入门指南。
一个活跃的 SignNow API 应用程序。
系统已安装 Python 3.11+（通过 python3 --version 检查）
已安装 UVX（通过 uvx --version 检查）。推荐用于最快速的设置。
已配置环境变量
如果您的客户端支持可流式 HTTP，您可以使用预部署的服务器 URL https://mcp-server.signnow.com/mcp，而无需在本地运行。

快速运行 (uvx)

如果您使用 uv，则无需安装软件包即可运行服务器：

uvx --from signnow-mcp-server sn-mcp serve

1. 设置环境变量

# Create .env file with your SignNow credentials
# You can copy from env.example if you have the source code
# Or create .env file manually with required variables (see Environment Variables section below)

2. 安装并运行

选项 A：从 PyPI 安装（推荐）

# Install the package from PyPI
pip install signnow-mcp-server

# Run MCP server in standalone mode
sn-mcp serve

选项 B：从源码安装（开发）

# 1) Clone & configure
git clone https://github.com/signnow/sn-mcp-server.git
cd sn-mcp-server
cp .env.example .env
# fill in your values in .env

# 2) Install (editable for dev)
pip install -e .

# 3) Run as STDIO MCP server (recommended for local tools & Inspector)
sn-mcp serve

STDIO 是桌面客户端和本地测试的理想选择。

本地/远程 (HTTP)

# Start HTTP server on 127.0.0.1:8000
sn-mcp http

# Custom host/port
sn-mcp http --host 0.0.0.0 --port 8000

# Dev reload
sn-mcp http --reload

默认情况下，可流式 HTTP MCP 端点在 /mcp 下提供服务。示例 URL：

http://localhost:8000/mcp

Docker

# Build
docker build -t sn-mcp-server .

# Run HTTP mode (recommended for containers)
docker run --env-file .env -p 8000:8000 sn-mcp-server sn-mcp http --host 0.0.0.0 --port 8000

容器内的 STDIO 在许多客户端中不可靠。使用 Docker 时请优先选择 HTTP。

Docker Compose

# Only the MCP server
docker-compose up sn-mcp-server

# Both services (if defined)
docker-compose up

配置

复制 .env.example 为 .env 并填写值。所有设置在启动时都会通过 pydantic-settings 进行验证。

身份验证选项

1) 用户名 / 密码（推荐用于桌面开发流程）

SIGNNOW_USER_EMAIL=<email>
SIGNNOW_PASSWORD=<password>
SIGNNOW_API_BASIC_TOKEN=<base64 basic token>

2) OAuth 2.0（用于托管/高级场景）

SIGNNOW_CLIENT_ID=<client_id>
SIGNNOW_CLIENT_SECRET=<client_secret>
# + OAuth server & RSA settings below

通过某些桌面客户端运行时，可能仅支持用户名/密码。

SignNow 与 OAuth 设置

# SignNow endpoints (defaults shown)
SIGNNOW_APP_BASE=https://app.signnow.com
SIGNNOW_API_BASE=https://api.signnow.com

# Optional direct API token (not required for normal use)
SIGNNOW_TOKEN=<access_token>

# OAuth server (if you enable OAuth mode)
OAUTH_ISSUER=<your_issuer_url>
ACCESS_TTL=3600
REFRESH_TTL=2592000
ALLOWED_REDIRECTS=<comma,separated,uris>

# RSA keys for OAuth (critical in production)
OAUTH_RSA_PRIVATE_PEM=<PEM content>
OAUTH_JWK_KID=<key id>

生产环境密钥管理

如果生产环境中缺少 OAUTH_RSA_PRIVATE_PEM，则每次重启时都会生成新的 RSA 密钥，从而使所有现有令牌失效。在生产环境中，请务必通过密钥管理提供持久的私钥。

客户端设置

VS Code — GitHub Copilot (代理模式) / Cursor

在您的工作区中创建 .vscode/mcp.json 或 .cursor/mcp.json：

STDIO (本地):

{
  "servers": {
    "signnow": {
      "command": "sn-mcp",
      "args": ["serve"],
      "env": {
        "SIGNNOW_USER_EMAIL": "${env:SIGNNOW_USER_EMAIL}",
        "SIGNNOW_PASSWORD": "${env:SIGNNOW_PASSWORD}",
        "SIGNNOW_API_BASIC_TOKEN": "${env:SIGNNOW_API_BASIC_TOKEN}"
      }
    }
  }
}

STDIO (uvx — 无需本地安装):

{
  "servers": {
    "signnow": {
      "command": "uvx",
      "args": ["--from", "signnow-mcp-server", "sn-mcp", "serve"],
      "env": {
        "SIGNNOW_USER_EMAIL": "${env:SIGNNOW_USER_EMAIL}",
        "SIGNNOW_PASSWORD": "${env:SIGNNOW_PASSWORD}",
        "SIGNNOW_API_BASIC_TOKEN": "${env:SIGNNOW_API_BASIC_TOKEN}"
      }
    }
  }
}

HTTP (远程或 Docker):

{
  "servers": {
    "signnow": {
      "type": "http",
      "url": "http://localhost:8000/mcp"
    }
  }
}

然后打开聊天 → 代理模式 (Agent mode)，启用 signnow 工具，并在提示词中使用它们。

注意：相同的配置也适用于 Cursor — 在 MCP 设置下添加它（STDIO 或 HTTP）。对于 STDIO，您也可以如上所示使用 uvx。

Claude Desktop

使用桌面扩展或手动配置 MCP（开发者 → 编辑配置）。

步骤：

打开 Claude Desktop → 开发者 → 编辑配置
在 mcpServers 下添加一个新的服务器条目
保存并重启 Claude Desktop

示例：

STDIO (本地安装):

{
  "mcpServers": {
    "signnow": {
      "command": "sn-mcp",
      "args": ["serve"],
      "env": {
        "SIGNNOW_USER_EMAIL": "${env:SIGNNOW_USER_EMAIL}",
        "SIGNNOW_PASSWORD": "${env:SIGNNOW_PASSWORD}",
        "SIGNNOW_API_BASIC_TOKEN": "${env:SIGNNOW_API_BASIC_TOKEN}"
      }
    }
  }
}

STDIO (uvx — 无需本地安装):

{
  "mcpServers": {
    "signnow": {
      "command": "uvx",
      "args": ["--from", "signnow-mcp-server", "sn-mcp", "serve"],
      "env": {
        "SIGNNOW_USER_EMAIL": "${env:SIGNNOW_USER_EMAIL}",
        "SIGNNOW_PASSWORD": "${env:SIGNNOW_PASSWORD}",
        "SIGNNOW_API_BASIC_TOKEN": "${env:SIGNNOW_API_BASIC_TOKEN}"
      }
    }
  }
}

HTTP (远程或 Docker):

{
  "mcpServers": {
    "signnow": {
      "type": "http",
      "url": "http://localhost:8000/mcp"
    }
  }
}

然后启用 Claude 聊天中的服务器并开始使用这些工具。

Glama (托管 MCP)

在 Glama 上部署并运行此服务器，只需极简设置：

步骤：

在 Glama 上打开服务器页面：sn-mcp-server on Glama
点击红色的“部署服务器 (Deploy Server)”按钮
在环境变量中提供：
- SIGNNOW_USER_EMAIL
- SIGNNOW_PASSWORD
- SIGNNOW_API_BASIC_TOKEN
- （其他变量可保留为默认值）
在 Glama 中创建一个访问令牌并复制端点 URL。它看起来像这样：

https://glama.ai/endpoints/{someId}/mcp?token={glama-mcp-token}

在任何支持 HTTP 传输的客户端中使用此 HTTP MCP URL（例如 VS Code/Cursor JSON 配置或上面的 Claude Desktop HTTP 示例）。

MCP Inspector (测试)

非常适合直观地探索工具和架构。

# Start Inspector (opens UI on localhost)
npx @modelcontextprotocol/inspector

# Connect (STDIO): run your server locally and attach
sn-mcp serve

# Or connect (HTTP): use http://localhost:8000/mcp

您可以列出工具、使用 JSON 参数调用它们并检查响应。

工具

每个工具都有简要描述；请使用 MCP 客户端（例如 Inspector）查看确切的 JSON 架构。

list_all_templates — 列出模板和模板组，包含简化的元数据。支持 limit/offset 分页（默认：每页 50 项）。
list_documents — 浏览您的文档、文档组和状态。支持 limit/offset 分页（默认：每页 50 项）。
create_from_template — 从模板/组创建文档或组。
send_invite — 电子邮件邀请（文档或组），支持有序收件人。
create_embedded_invite — 无需电子邮件投递的嵌入式签名会话。
create_embedded_sending — 嵌入式“发送/管理”体验。
create_embedded_editor — 用于放置/调整字段的嵌入式编辑器链接。
send_invite_from_template — 一键式：从模板创建并邀请。
create_embedded_sending_from_template — 一键式：模板 → 嵌入式发送。
create_embedded_editor_from_template — 一键式：模板 → 嵌入式编辑器。
create_embedded_invite_from_template — 一键式：模板 → 嵌入式签名。
get_invite_status — 文档或组的当前邀请状态/步骤。
get_document_download_link — 直接下载链接（组的合并输出）。
get_signing_link — 获取文档或文档组的签名链接。
get_document — 带有字段值的规范化文档/组结构。
update_document_fields — 预填充单个文档中的文本字段。
upload_document — 从本地文件路径 (file_path)、公共 URL (file_url) 或 MCP 资源附件 (resource_uri) 上传文档。对于 file_path，解析后的路径必须位于配置的安全基础目录内（默认为用户主目录）；超出该基础目录的路径将无法通过验证。支持：PDF, DOC, DOCX, PNG, JPG, JPEG。最大 40 MB。返回 document_id, filename, source。
send_invite_reminder — 向文档或文档组中待处理的签署人发送签名提醒。
signnow_skills — 查询捆绑的 SignNow 技能库。省略 skill_name 可列出所有可用技能及其描述；提供 skill_name（例如 signnow101）可获取完整的 Markdown 正文。使用 signnow101 了解 SignNow 实体类型、邀请类型和工具映射。
- 列表模式示例：{"skills": [{"name": "signnow101", "description": "SignNow 101 概念参考... (描述因篇幅限制已截断)"}]}
- 获取模式示例：{"name": "signnow101", "body": "# SignNow 101 — 概念参考\n..."}

提示：从 signnow_skills（无参数）开始以发现可用技能，然后是 list_all_templates → create_from_template → create_embedded_* / send_invite，最后是 get_invite_status 和 get_document_download_link。

常见问题 / 提示

STDIO 还是 Docker？ 本地开发优先选择 STDIO；在 Docker 内部，使用 HTTP。
沙盒还是生产？ 从 SignNow 的沙盒/开发凭据开始；生产环境需要正确的 OAuth 和持久的 RSA 私钥。
在哪里查看确切的工具架构？ 使用 MCP Inspector 或您客户端的“工具详情”视图。
示例在哪里？ 查看此仓库中的 examples/ 以获取入门集成。

示例

examples/ 目录包含如何将 SignNow MCP 服务器与流行 AI 代理框架集成的有效示例：

LangChain - 使用 langchain-mcp-adapters 与 LangChain 代理集成
LlamaIndex - 使用 llama-index-tools-mcp 与 LlamaIndex 代理集成
SmolAgents - 使用原生 MCP 支持与 SmolAgents 框架集成

每个示例都演示了如何：

将 MCP 服务器作为子进程启动
将 MCP 工具转换为框架特定的工具格式
创建可以使用 SignNow 功能的代理
处理环境变量配置

运行示例：

# Make sure you have the required dependencies installed
pip install langchain-openai langchain-mcp-adapters  # for LangChain example
pip install llama-index-tools-mcp                   # for LlamaIndex example  
pip install smolagents                              # for SmolAgents example

# Set up your .env file with SignNow credentials and LLM configuration
# Then run the example
python examples/langchain/langchain_example.py
python examples/llamaindex/llamaindex_example.py
python examples/smolagents/stdio_demo.py

实用资源

示例应用

探索现成的示例应用，快速测试如何使用 SignNow API 从您的软件中准备、签署和发送文档。

尝试示例应用。

API 文档

查找有关 SignNow API 请求、参数、代码示例和可能错误的详细技术信息。在详细指南和用例中了解更多关于 API 功能的信息。

阅读 API 文档。

SignNow API 助手 MCP

连接您的 AI 以访问 API 文档、为复杂签名工作流生成代码，并自动排查集成错误。访问 API 助手 MCP

许可证

MIT — 参见 LICENSE.md。

关于 SignNow MCP 服务器 — 由 SignNow 团队维护。欢迎通过 GitHub Pull Request 提交问题和贡献。

SignNow MCP Server