Skip to content

Latest commit

 

History

History
250 lines (202 loc) · 7.25 KB

File metadata and controls

250 lines (202 loc) · 7.25 KB

mcp-server-plaid: A Plaid MCP server

Overview

A Model Context Protocol server for facilitating integration with Plaid. This server provides tools to generate mock financial data, search Plaid documentation, and interact with sandbox APIs for testing purposes.

Tools

  1. get_mock_data_prompt

    • Return prompt to generate customized mock financial data for testing
  2. search_documentation

    • Search Plaid documentation for relevant information about products or API endpoints
    • Returns: Detailed information from Plaid's documentation
  3. get_sandbox_access_token

    • Obtain a working access token for the Plaid sandbox environment
    • Returns: Access token and item ID for testing with sandbox mocked data
  4. simulate_webhook

    • Simulate a Plaid webhook event in the sandbox environment
    • Useful for testing your application's webhook handling
    • Returns: Webhook fired status and status code

Configuration

Obtaining API Credentials

  1. Sign in to your Plaid Developer Dashboard account
  2. Navigate to DevelopersKeys
  3. Locate your sandbox credentials as illustrated in the screenshot below.

Important

All PLAID_CLIENT_ID and PLAID_SECRET references in the following MCP configuration use sandbox credentials.

image

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

Using uvx
{
  "mcpServers": {
    "plaid": {
      "command": "uvx",
      "args": [
        "mcp-server-plaid",
        "--client-id",
        "YOUR_PLAID_CLIENT_ID",
        "--secret",
        "YOUR_PLAID_SECRET"
      ]
    }
  }
}
Using pip installation
{
  "mcpServers": {
    "plaid": {
      "command": "python",
      "args": [
        "-m",
        "mcp_server_plaid",
        "--client-id",
        "YOUR_PLAID_CLIENT_ID",
        "--secret",
        "YOUR_PLAID_SECRET"
      ]
    }
  }
}

Usage with Cursor

For quick installation, use the one-click installation button

Add plaid MCP server to Cursor

For manual installation, add the following JSON block to Cursor MCP config file,

Using uvx
{
  "mcpServers": {
    "plaid": {
      "command": "uvx",
      "args": [
        "mcp-server-plaid",
        "--client-id",
        "YOUR_PLAID_CLIENT_ID",
        "--secret",
        "YOUR_PLAID_SECRET"
      ]
    }
  }
}
Using pip installation
{
  "mcpServers": {
    "plaid": {
      "command": "python",
      "args": [
        "-m",
        "mcp_server_plaid",
        "--client-id",
        "YOUR_PLAID_CLIENT_ID",
        "--secret",
        "YOUR_PLAID_SECRET"
      ]
    }
  }
}

Usage with VS Code

For quick installation, use one of the one-click installation buttons below,

Install with UV in VS Code Install with UV in VS Code Insiders

For manual installation, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing Ctrl + Shift + P and typing Preferences: Open Settings (JSON).

Optionally, you can add it to a file called .vscode/mcp.json in your workspace. This will allow you to share the configuration with others.

Note that the mcp key is needed when using the mcp.json file.

Using uvx
{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "client_id",
        "description": "Plaid Client ID",
        "password": false
      },
      {
        "type": "promptString",
        "id": "secret",
        "description": "Plaid Secret",
        "password": true
      }
    ],
    "servers": {
      "plaid": {
        "command": "uvx",
        "args": ["mcp-server-plaid"],
        "env": {
          "PLAID_CLIENT_ID": "${input:client_id}",
          "PLAID_SECRET": "${input:secret}"
        }
      }
    }
  }
}

Usage with Zed

Add to your Zed settings.json:

Using uvx
{
   "context_servers": {
      "mcp-server-plaid": {
         "command": {
            "path": "uvx",
            "args": [
               "mcp-server-plaid",
               "--client-id",
               "YOUR_PLAID_CLIENT_ID",
               "--secret",
               "YOUR_PLAID_SECRET"
            ]
         }
      }
   }
}
Using pip installation
{
  "context_servers": {
    "mcp-server-plaid": {
      "command": "python",
      "args": [
        "-m",
        "mcp_server_plaid",
        "--client-id",
        "YOUR_PLAID_CLIENT_ID",
        "--secret",
        "YOUR_PLAID_SECRET"
      ]
    }
  }
}

Debugging

You can use the MCP inspector to debug the server. For uvx installations:

npx @modelcontextprotocol/inspector uvx mcp-server-plaid --client-id YOUR_PLAID_CLIENT_ID --secret YOUR_PLAID_SECRET

Or if you've installed the package in a specific directory or are developing on it:

cd path/to/servers/src/plaid
npx @modelcontextprotocol/inspector uv run mcp-server-plaid --client-id YOUR_PLAID_CLIENT_ID --secret YOUR_PLAID_SECRET

License

This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository.