Vitally

Provides access to Vitally customer data via the Vitally API, including accounts, health scores, conversations, tasks, and notes.

javascript

GitHub Stars

javascript

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "fiscaltec-vitally-mcp": {
      "command": "node",
      "args": [
        "--experimental-modules",
        "--experimental-specifier-resolution=node",
        "/Users/johnjung/nylas/vitally/vitally/build/index.js"
      ],
      "env": {
        "VITALLY_API_KEY": "VITALLY_API_KEY",
        "VITALLY_DATA_CENTER": "VITALLY_DATA_CENTER",
        "VITALLY_API_SUBDOMAIN": "VITALLY_API_SUBDOMAIN"
      }
    }
  }
}

You can access Vitally customer data through this MCP server, enabling you to list accounts, read details, search users, view conversations and tasks, and create notes — all through a consistent MCP interface. When you provide a Vitally API key, you get real data; if you don’t, you’ll still be able to explore the demo data locally.

How to use

Connect to the Vitally MCP server from your MCP client to manage accounts, health scores, conversations, tasks, and notes. You can test and debug with the built-in inspector, start the server locally, or run it inside Docker. Use the client to perform common actions such as listing customers, finding accounts by name or external ID, and retrieving recent conversations for an account.

To test and iterate quickly, run the MCP Inspector to interact with your server during development.

How to install

Prerequisites you need before installing: Node.js and npm.

Install dependencies.

npm install

Create an environment file in the project root and populate Vitally API configurations.

VITALLY_API_SUBDOMAIN=nylas
VITALLY_API_KEY=your_api_key_here
VITALLY_DATA_CENTER=US

Build the project.

npm run build

If you don’t have a Vitally API key yet, the server will run in demo mode with mock data.

Additional configuration and running methods

You can run the Vitally MCP server in two ways: as a local stdio server or inside Docker. The commands below are the runtime instructions you will use in your MCP client configuration.

Local stdio start (Claude Desktop example)

node --experimental-modules --experimental-specifier-resolution=node /Users/johnjung/nylas/vitally/vitally/build/index.js

Docker run (from a container registry)

docker run --rm -i -e VITALLY_API_SUBDOMAIN -e VITALLY_API_KEY -e VITALLY_DATA_CENTER ghcr.io/fiscaltec/vitally-mcp

Security and environment variables

The server reads Vitally API credentials from environment variables. Ensure you keep your API key secret and do not commit credentials to source control.

Environment variables shown for running the server include:

VITALLY_API_SUBDOMAIN: your Vitally subdomain (e.g., nylas)
VITALLY_API_KEY: your Vitally API key (Secret Token)
VITALLY_DATA_CENTER: US or EU depending on your data center

Available tools

search_tools

Search for available MCP tools by keyword

search_accounts

Search accounts by name, externalId, or criteria

find_account_by_name

Find accounts by their name with partial matching support

refresh_accounts

Refresh the cached list of accounts from Vitally

get_account_health

Retrieve health scores for a specific account

search_users

Search users by email, external ID, or email subdomain

get_account_conversations

Get recent conversations for an account

get_account_tasks

Get tasks for an account, with optional status filter

create_account_note

Create a new note for an account

Built by

VeilStrat

AI signals for GTM teams