Category / Section
How to use BoldSign MCP Server in Windsurf?
Published:
3 mins read
The Model Context Protocol (MCP) extends LLM capabilities, enabling them to act as agents that connect to external systems. The BoldSign MCP server is designed to facilitate interaction between Large Language Models (LLMs) and the BoldSign API.
Prerequisites
Before you begin, ensure you have the following installed and set up:
- BoldSign Account: You will need an account to obtain API credentials. You can sign up for a free trial or use an existing sandbox or paid account.
- BoldSign API Key: Generate an API key from the BoldSign web app. Refer to the BoldSign API documentation for instructions.
- Node.js: Version 18.0.0 or later.
- Windsurf: Download and install Windsurf.
Installation
- This section assumes that you have installed and signed in to Windsurf.
- On the Command Palette (Press Ctrl + Shift + P), type
Settings
and select theOpen Windsurf User settings
option to open the settings panel.
- Under the
Cascade
section, click on theManage MCPs
option.
- The
Manage MCP Servers
window will open. Click on theView raw config
button.
- An
mcp.config.json
file will open. Add the following configuration:
{
"mcpServers": {
"boldsign": {
"command": "npx",
"args": ["-y", "@boldsign/mcp"],
"env": {
"BOLDSIGN_API_KEY": "YOUR_BOLDSIGN_API_KEY",
"BOLDSIGN_API_REGION": "US"
}
}
}
}
- Replace
YOUR_BOLDSIGN_API_KEY
with your actual BoldSign API key. TheBOLDSIGN_API_REGION
can be set toUS
EU
, orCA
depending on your account region. - Save the configuration file and restart Windsurf to apply the changes.
- Open the Cascade panel and try a command like:
Send NDA Agreement to Cathy Sam
. - Cascade will use the MCP server to locate the template, fetch the contact, and send the document for signature.
BoldSign MCP tools
The MCP server provides access to the following tools via the BoldSign API:
Documents
- List documents: Retrieves a paginated list of your documents.
- List team documents: Retrieves a paginated list of team documents.
- Get document: Retrieves detailed information, including status, for a specific document using its ID.
- Revoke document: Allows you to cancel or call off a document that is in progress.
- Send reminders: Sends reminders to signers who have not yet completed their signature on a document.
Templates
- List templates: Retrieves a paginated list of templates available in your BoldSign account.
- Get template: Retrieves detailed information for a specific template using its ID.
- Send document from template: Creates and sends out a document for signing based on a pre-configured template.
Contacts
- List Contacts: Retrieves a paginated list of contacts from your BoldSign account.
- Get Contact: Retrieves detailed information for a specific contact using their ID.
Users
- List Users: Retrieves a paginated list of users in your BoldSign organization.
- Get User: Retrieves detailed information for a specific user using their ID.
Teams
- List Teams: Retrieves a paginated list of teams in your BoldSign organization.
- Get Team: Retrieves detailed information for a specific team using their ID.