​
Overview

We provide two MCP servers:

  • REST APIs MCP Server: Allows you to interact with your Velt data directly from various MCP compatible clients, such as Cursor, Windsurf, Claude Desktop, etc.
  • Docs MCP Server: Allows you to search and browse Velt’s documentation directly within your MCP-compatible IDEs, like Cursor, Windsurf etc. This enables you to quickly find information about our SDKs, APIs, and features without having to leave your editor, streamlining your development workflow when implementing Velt.

​
Supported MCP Clients

The MCP server is compatible with any client that supports MCP. Here are few examples:

​
REST APIs MCP Server

This allows you to interact with your Velt data directly from various MCP compatible clients, such as Cursor, Windsurf, Claude Desktop, etc.

​
Tools

The MCP server exposes all the Velt REST APIs as tools. Below you will find links to different collections of APIs:

​
Setup

You can set up the REST API MCP Server using any of the following methods. Note you will be required to provide your Velt API key and Velt Auth token to the MCP server.

​
Using Smithery CLI

The easiest way to get started is by using the @smithery/cli package installer. This will automatically download and configure the MCP server for your chosen client. You can visit: https://smithery.ai/server/@velt-js/velt-api-mcp to see the list of clients supported by the MCP server and steps to install it. Here are some examples:

npx -y @smithery/cli install @velt-js/velt-api-mcp --client claude

​
Manual Configuration

If you prefer to configure the server manually, follow these steps.

  1. Install the Server Package:
npm i @veltdev/api-mcp
  1. Configure your client: Here are some examples:

  1. Open Claude Desktop.

  2. Go to Settings > Developer > Edit Config.

  3. Add the following configuration to the mcpServers section in your config file. Make sure to replace the placeholder values.

    {
  "mcpServers": {
    "velt-api-mcp": {
      "command": "node",
      "args": ["<path-to-velt-api-mcp-server-folder>/dist/index.js"],
      "env": {
        "VELT_API_KEY": "<your-velt-api-key>",
        "VELT_AUTH_TOKEN": "<your-velt-auth-token>"
      }
    }
  }
}

  4. Save the configuration file.

  5. Restart Claude Desktop. The velt-api-mcp server will now be available in the tools menu.

​
Use cases

Once configured, you can interact with the Velt API through your MCP client. Here are some examples:

  1. Querying Velt Data:
  • How many comments are there in this organization: ORGANIZATION_ID?
  • Provide a list of users in the this organization: ORGANIZATION_ID.
  • Give me a list of all open comments in this organization: ORGANIZATION_ID.
  • Get all notifications for this user: USER_ID.
  • and more…
  1. Adding or updating sample data:
  • Add, update or delete comments in a given document.
  • Add notification for a given user.
  • and more…
  1. Analysis: If you are using an agentic client like Cursor, you can also ask questions like:
  • What are users discussing in comments in this organization: ORGANIZATION_ID?
  • Categorize the comments as bugs, feature requests, questions, etc in this organization: ORGANIZATION_ID.
  • and more…
  1. Debugging:
  • Add a comment using SDK and ask the MCP to fetch the comment.
  • Tag a user in a comment using SDK and ask the MCP to fetch the notification for the user.
  • and more…
  1. Use it as a tool for your AI Agent:
  • You could review a document (eg: essay, report, etc) and ask the Velt MCP to add comments providing contextual feedback on the document.
  • Here is a sample code of using MCP tool in AI agent with Google AI SDK:
TARGET_FOLDER_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), "")

root_agent = Agent(
    name="AI Comment Agent",
    model="gemini-2.5-flash",
    description="Agent that adds comments for the product",
    instruction="""
    You are a reviewer who will review the text given and add the comment to improve the content
    """,
    tools=[
        MCPToolset(
            connection_params=StdioServerParameters(
                command='npx',
                args=[
                    "-y",
                    "@veltdev/api-mcp",
                    os.path.abspath(TARGET_FOLDER_PATH),
                ],
                stderr=subprocess.STDOUT, 
                timeout=60,
                env={
                    "VELT_API_KEY": api_key,
                    "VELT_AUTH_TOKEN": auth_token,
                }
            ),
            tool_filter=[
                'get-comment-annotations', 
                'get-comments',
                'add-comments',
                'update-comments',  
                'delete-comments',
                'add-comment-annotations', 
                'update-comment-annotations', 
                'delete-comment-annotations', 
            ]
        )
    ],
)

​
Docs MCP Server

The Velt Docs MCP Server allows you to search and browse Velt’s documentation directly within your MCP-compatible client, like Cursor, Windsurf, Claude Desktop and more. This enables you to quickly find information about our SDKs, APIs, and features without having to leave your editor, streamlining your development workflow when implementing Velt.

​
Setup

npx mint-mcp add velt

​
Example Usage

Once the Velt Docs MCP Server is configured, you can use it to search for documentation from your client.

For example, in Cursor, you can use the @velt command in the chat to ask questions about Velt.

Query: @velt how to add popover comments?

Result: The MCP will return relevant documentation pages and snippets related to adding popover comments, allowing you to quickly access the information you need.

More examples:

  • @velt generate sample data for adding comment annotations via rest api