How do I get an API Key for Freshsales?

Log in to your Freshsales account, click on your Profile picture in the top-right corner, go to 'Profile Settings', and navigate to the 'API Settings' tab to find your Token.

What is my 'Domain prefix'?

Your domain prefix is the first part of your Freshsales or Freshworks CRM URL (e.g. if your URL is 'acme.myfreshworks.com/crm/sales' or 'acme.freshsales.io', the prefix is 'acme').

Can I create a new lead through the agent?

Yes! Use the 'create_crm_lead' tool and provide the first name, last name, and optionally an email address to instantly add them to your CRM.

Are custom fields supported?

When you retrieve a record (like a deal or contact) using tools like 'get_deal_details', the agent fetches the complete metadata payload, which includes all configured custom fields.

Freshsales MCP Server for VS Code Copilot 12 tools — connect in under 2 minutes

Name: Freshsales
Availability: InStock
Author: Vinkius

code.visualstudio.com/docs/copilot/chat/mcp-servers

Built by Vinkius GDPR 12 Tools IDE

GitHub Copilot in VS Code is the most widely adopted AI coding assistant, embedded directly into the world's most popular code editor. With MCP support in Agent mode, Copilot can access external data and APIs to generate context-aware code grounded in real-time information.

Get MCP Server for AI Agents

ASK AI ABOUT THIS MCP SERVER

Open in ChatGPT Open in Claude Open in Perplexity

Vinkius supports streamable HTTP and SSE.

RecommendedModern Approach — Zero Configuration

Vinkius Desktop App

The modern way to manage MCP Servers — no config files, no terminal commands. Install Freshsales and 2,500+ MCP Servers from a single visual interface.

Download Free Open SourceNo signup required

Classic Setup·json

{
  "mcpServers": {
    "freshsales": {
      "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    }
  }
}

Fully ManagedVinkius Servers

60%Token savings

High SecurityEnterprise-grade

IAMAccess control

EU AI ActCompliant

DLPData protection

V8 IsolateSandboxed

Ed25519Audit chain

<40msKill switch

Stream every event to Splunk, Datadog, or your own webhook in real-time

* Every MCP server runs on Vinkius-managed infrastructure inside AWS - a purpose-built runtime with per-request V8 isolates, Ed25519 signed audit chains, and sub-40ms cold starts optimized for native MCP execution. See our infrastructure

About Freshsales MCP Server

Connect your Freshsales account to any AI agent to automate your sales CRM operations through the Model Context Protocol (MCP). Freshsales is a powerful sales CRM that provides a 360-degree view of your customers. This MCP server enables you to track active deals, manage lead data, and retrieve detailed contact profiles directly through natural conversation.

GitHub Copilot Agent mode brings Freshsales data directly into your VS Code workflow. With a project-scoped config, the entire team shares access to 12 tools. Copilot queries live data, generates typed code, and writes tests from actual API responses, all without leaving the editor.

Key Features

Lead & Contact Oversight — List all leads and contacts, fetch detailed profiles, and create new leads instantly to keep your pipeline full.
Deal Management — Access your sales opportunities, monitor deal stages, and retrieve detailed metadata to track revenue.
Account Discovery — List and search for company accounts to maintain full context of your B2B relationships.
Task & Appointment Tracking — Monitor scheduled meetings and pending sales tasks to ensure no follow-up is missed.
Sales Team Insights — List all CRM users and sales representatives to understand territory assignments and workloads.
Real-time Synchronization — Keep your sales data accessible to your AI assistant without leaving your primary workspace.

The Freshsales MCP Server exposes 12 tools through the Vinkius. Connect it to VS Code Copilot in under two minutes — no API keys to rotate, no infrastructure to provision, no vendor lock-in. Your configuration, your data, your control.

How to Connect Freshsales to VS Code Copilot via MCP

Follow these steps to integrate the Freshsales MCP Server with VS Code Copilot.

Create MCP config

Create a .vscode/mcp.json file in your project root

Add the server config

Paste the JSON configuration above

Enable Agent mode

Open GitHub Copilot Chat and switch to Agent mode using the dropdown

Start using Freshsales

Ask Copilot: "Using Freshsales, help me...". 12 tools available

Why Use VS Code Copilot with the Freshsales MCP Server

GitHub Copilot for Visual Studio Code provides unique advantages when paired with Freshsales through the Model Context Protocol.

VS Code is used by over 70% of developers. adding MCP tools to Copilot means your team can leverage external data without leaving their primary editor

Project-scoped MCP configs (`.vscode/mcp.json`) let you commit server configurations to your repository, ensuring the entire team shares the same tool access

Copilot's Agent mode integrates MCP tools seamlessly with file editing, terminal commands, and workspace search in a single agentic loop

GitHub's enterprise compliance and audit features extend to MCP tool usage, providing visibility into how AI interacts with external services

Freshsales + VS Code Copilot Use Cases

Practical scenarios where VS Code Copilot combined with the Freshsales MCP Server delivers measurable value.

Live API integration: Copilot can query an MCP server, inspect the response schema, and generate typed API client code in the same step

DevSecOps workflows: security teams can give developers access to domain intelligence tools directly in their editor for real-time vulnerability assessment during code review

Data pipeline development: Copilot fetches sample data via MCP and generates transformation scripts, validators, and test fixtures from actual API responses

Documentation generation: Copilot queries available tools and auto-generates README sections, API reference docs, and usage examples

Freshsales MCP Tools for VS Code Copilot (12)

These 12 tools become available when you connect Freshsales to VS Code Copilot via MCP:

create_crm_lead

Create a new lead

get_account_details

Get account metadata

get_contact_metadata

Get contact details

get_deal_details

Get deal metadata

get_lead_details

Get lead metadata

list_appointments

List scheduled appointments

list_crm_contacts

List CRM contacts

list_crm_deals

List sales deals

list_crm_leads

List CRM leads

list_crm_tasks

List pending tasks

list_crm_users

List CRM users

list_sales_accounts

List CRM accounts

Example Prompts for Freshsales in VS Code Copilot

Ready-to-use prompts you can give your VS Code Copilot agent to start working with Freshsales immediately.

"List my 5 most recent active sales deals."

"Show me the contact details for 'Jane Smith'."

"Create a new lead for 'John Doe' (johndoe@email.com)."

Troubleshooting Freshsales MCP Server with VS Code Copilot

Common issues when connecting Freshsales to VS Code Copilot through the Vinkius, and how to resolve them.

MCP tools not available

Ensure you are in Agent mode in Copilot Chat. MCP tools only appear in Agent mode.

Freshsales + VS Code Copilot FAQ

Common questions about integrating Freshsales MCP Server with VS Code Copilot.

Which VS Code version supports MCP?

MCP support requires VS Code 1.99 or later with the GitHub Copilot extension. Ensure both are updated to the latest version. Older versions of Copilot may not expose the Agent mode toggle.

How do I switch to Agent mode?

Open the Copilot Chat panel and look for two mode options: "Ask" and "Agent". Click "Agent" to enable autonomous tool calling. In Ask mode, Copilot provides conversational answers but cannot invoke MCP tools.

Can I restrict which MCP tools Copilot can access?

Yes. VS Code shows a tool consent dialog before any MCP tool is invoked for the first time. You can also configure tool access policies at the organization level through GitHub Copilot settings.

Does MCP work in VS Code Remote or Codespaces?

Yes. MCP servers configured via .vscode/mcp.json work in Remote SSH, WSL, and GitHub Codespaces environments. The MCP connection is established from the remote host, so ensure the server URL is accessible from that environment.