Articles in this section
Category / Section

How to use BoldSign MCP Server in VS Code?

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: Install Node.js (version 18.0.0 or higher).
  • VS Code: Install the latest version of Visual Studio Code.
  • Set up Copilot: Set up GitHub Copilot in VS Code.

Installation

You have multiple options to add an MCP server in VS Code:

1. Workspace configuration

  • Clone the BoldSign MCP Server from its GitHub repository into VS Code.
git clone https://github.com/boldsign/boldsign-mcp.git
cd boldsign-mcp
  • Create a file in your project folder:
.vscode/mcp.json
  • Add this configuration to the file:
{
  "servers": {
    "boldsign": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@boldsign/mcp"],
      "env": {
        "BOLDSIGN_API_KEY": "YOUR_BOLDSIGN_API_KEY",
        "BOLDSIGN_API_REGION": "US"
      }
    }
  }
}

mcp.json file

  • Replace YOUR_BOLDSIGN_API_KEY with your actual BoldSign API key. The BOLDSIGN_API_REGION can be set to US, EU, or CA depending on your account region.
  • Then click the Add Server button.

Add sever button

  • Choose the command that will implement the MCP protocol and save the changes (Ctrl + S).

Command

  • The Start button will be displayed. Click it to begin running your project.

Start button

  • Your project is now fully configured, and you can utilize the available BoldSign MCP Server tools.

Tools

  • To view and manage the list of configured MCP servers, run the MCP: Show Installed Servers command from the Command Palette or visit the MCP SERVERS - INSTALLED section in the Extensions view.

2. User settings

Open Command Palette in VS Code:

Ctrl + Shift + P (or Cmd + Shift + P on Mac)
Search for:

MCP: Open User Configuration

Command palette

Add the same configuration as above in the user settings.

3. Automatic discovery

If you’re using other tools like Claude Desktop, which already have the BoldSign MCP server installed, then you can enable automatic discovery to add it directly:

  • Open VS Code settings and search for:
chat.mcp.discovery.enabled
  • Enable autodiscovery with the chat.mcp.discovery.enabled setting.

chat.mcp.discovery.enabled

VS Code will then automatically detect MCP servers from other tools.

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.

MCP support in VS Code is available starting from VS Code 1.102, but can be disabled by your organization.

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
Access denied
Access denied