> ## Documentation Index
> Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP Server

> Connect your AI assistant to Vendaze and let it read and manage your CRM directly in the conversation.

The Vendaze MCP (Model Context Protocol) server lets you connect AI assistants to your Vendaze account. Once connected, your assistant can search contacts, view deals, create tasks, log activities, and much more, all from within the conversation, without you having to open Vendaze.

## Platforms with native integration

The Vendaze MCP is available as a listed integration in **Claude** and **ChatGPT**. On these platforms, simply search for Vendaze and connect your account, no technical setup required.

<CardGroup cols={2}>
  <Card title="Claude" icon="comment-dots" href="/en/ai/claude">
    Connect via the Claude app directory.
  </Card>

  <Card title="ChatGPT" icon="robot" href="/en/ai/chatgpt">
    Connect via ChatGPT connectors.
  </Card>
</CardGroup>

## Other platforms and IDEs

The Vendaze MCP can be connected in any client that supports the Model Context Protocol. Select your tool to see the setup instructions:

<Tabs>
  <Tab title="Claude Code">
    Run the following command in your terminal to add the Vendaze MCP server:

    ```bash theme={null}
    claude mcp add --transport http vendaze https://mcp.vendaze.com/mcp
    ```

    The server will be available in all Claude Code sessions from that point on.
  </Tab>

  <Tab title="Cursor">
    Open `~/.cursor/mcp.json` (or create it if it does not exist) and add the Vendaze entry:

    ```json theme={null}
    {
      "mcpServers": {
        "vendaze": {
          "url": "https://mcp.vendaze.com/mcp"
        }
      }
    }
    ```

    Restart Cursor after saving. The server will appear in the MCP panel in settings.
  </Tab>

  <Tab title="Windsurf">
    Open `~/.codeium/windsurf/mcp_config.json` (or create it if it does not exist) and add the Vendaze entry:

    ```json theme={null}
    {
      "mcpServers": {
        "vendaze": {
          "serverUrl": "https://mcp.vendaze.com/mcp"
        }
      }
    }
    ```

    Restart Windsurf after saving. The server will appear in the MCP tab in settings.
  </Tab>

  <Tab title="Kiro AI">
    Open `.kiro/settings/mcp.json` at the root of your project (or `~/.kiro/settings/mcp.json` for a global configuration) and add the Vendaze entry:

    ```json theme={null}
    {
      "mcpServers": {
        "vendaze": {
          "url": "https://mcp.vendaze.com/mcp"
        }
      }
    }
    ```

    Kiro reconnects automatically when the configuration file is saved.
  </Tab>

  <Tab title="GitHub Copilot">
    Create or edit `.vscode/mcp.json` at the root of your project and add the Vendaze entry:

    ```json theme={null}
    {
      "servers": {
        "vendaze": {
          "url": "https://mcp.vendaze.com/mcp"
        }
      }
    }
    ```

    For a global configuration, go to **Settings > MCP Servers** in VS Code and add the server through the UI.
  </Tab>

  <Tab title="Gemini CLI">
    Open `~/.gemini/settings.json` (or create it if it does not exist) and add the Vendaze entry:

    ```json theme={null}
    {
      "mcpServers": {
        "vendaze": {
          "httpUrl": "https://mcp.vendaze.com/mcp"
        }
      }
    }
    ```

    Gemini CLI loads the configuration automatically on the next run.
  </Tab>

  <Tab title="Codex CLI">
    Open `~/.codex/config.json` (or create it if it does not exist) and add the Vendaze entry:

    ```json theme={null}
    {
      "mcpServers": {
        "vendaze": {
          "url": "https://mcp.vendaze.com/mcp",
          "transport": "http"
        }
      }
    }
    ```

    Codex CLI loads the configuration automatically on the next run.
  </Tab>
</Tabs>

## What your assistant can do

Once connected, your AI assistant has access to the following actions on your Vendaze account:

### People

| Tool            | Description                                            |
| --------------- | ------------------------------------------------------ |
| `list_people`   | Lists contacts with filter and pagination support.     |
| `get_person`    | Fetches a person by ID with custom fields and company. |
| `create_person` | Creates a new contact in the workspace.                |
| `update_person` | Updates fields on an existing contact.                 |
| `delete_person` | Removes (soft delete) a contact.                       |

### Companies

| Tool             | Description                                         |
| ---------------- | --------------------------------------------------- |
| `list_companies` | Lists companies with filter and pagination support. |
| `get_company`    | Fetches a company by ID with custom fields.         |
| `create_company` | Creates a new company in the workspace.             |
| `update_company` | Updates fields on an existing company.              |
| `delete_company` | Removes (soft delete) a company.                    |

### Deals

| Tool          | Description                                                |
| ------------- | ---------------------------------------------------------- |
| `list_deals`  | Lists deals with pipeline, price, and date filter support. |
| `get_deal`    | Fetches a deal by ID with pipeline, stage, and products.   |
| `create_deal` | Creates a new deal.                                        |
| `update_deal` | Updates fields on an existing deal.                        |
| `delete_deal` | Removes (soft delete) a deal.                              |

### Tasks

| Tool               | Description                                          |
| ------------------ | ---------------------------------------------------- |
| `list_tasks`       | Lists tasks filtered by entity, priority, or status. |
| `create_task`      | Creates a new task.                                  |
| `update_task`      | Updates an existing task.                            |
| `delete_task`      | Removes a task.                                      |
| `list_task_types`  | Lists the task types available in the workspace.     |
| `create_task_type` | Creates a new task type.                             |
| `update_task_type` | Updates an existing task type.                       |
| `delete_task_type` | Removes a task type.                                 |

### Activities

| Tool              | Description                                            |
| ----------------- | ------------------------------------------------------ |
| `list_activities` | Lists activities linked to a person, company, or deal. |
| `get_activity`    | Fetches an activity by ID.                             |
| `create_activity` | Logs a new activity (call, meeting, email, or note).   |
| `delete_activity` | Removes an activity.                                   |

### Products

| Tool             | Description                                    |
| ---------------- | ---------------------------------------------- |
| `list_products`  | Lists the products available in the workspace. |
| `get_product`    | Fetches a product by ID.                       |
| `create_product` | Creates a new product.                         |
| `update_product` | Updates fields on an existing product.         |
| `delete_product` | Removes (soft delete) a product.               |

### Tags

| Tool         | Description                         |
| ------------ | ----------------------------------- |
| `list_tags`  | Lists all tags in the workspace.    |
| `get_tag`    | Fetches a tag by ID or key.         |
| `create_tag` | Creates a new tag.                  |
| `update_tag` | Updates the name or color of a tag. |
| `delete_tag` | Removes a tag from the workspace.   |

### Lists

| Tool          | Description                           |
| ------------- | ------------------------------------- |
| `list_lists`  | Lists contact lists in the workspace. |
| `create_list` | Creates a new contact list.           |
| `update_list` | Renames an existing list.             |
| `delete_list` | Removes a contact list.               |

### Custom Fields

| Tool                  | Description                                         |
| --------------------- | --------------------------------------------------- |
| `list_custom_fields`  | Lists the custom fields available in the workspace. |
| `create_custom_field` | Creates a new custom field.                         |
| `update_custom_field` | Updates an existing custom field.                   |
| `delete_custom_field` | Removes a custom field.                             |

### Pipelines

| Tool              | Description                                   |
| ----------------- | --------------------------------------------- |
| `list_pipelines`  | Lists pipelines and their stages.             |
| `get_pipeline`    | Fetches a pipeline by ID with all its stages. |
| `create_pipeline` | Creates a new pipeline with stages.           |
| `update_pipeline` | Updates a pipeline or its stages.             |

## Example prompts

Once connected, you can talk to your assistant naturally:

* "What are the 10 highest-value deals in the Commercial pipeline?"
* "Show me the contacts at Acme Corp with all their information."
* "Which tasks are open with an overdue date?"
* "Create a contact named John Smith at company XYZ with email [john@xyz.com](mailto:john@xyz.com)."
* "Move the deal 'Quarterly Contract' to the 'Proposal Sent' stage."
* "Add a note on contact Ana Costa saying she returns on the 15th."
* "Log a call on the Acme Corp deal saying we're waiting for their legal team's approval."

## Notes

* The MCP Server applies the same rate limits as the REST API.
* The connection uses your Vendaze account's OAuth authorization. The assistant only accesses the workspace you authorized.
* Custom fields are returned only in ID lookup tools (`get_*`), not in listings.