• Customermates logo
    CustomermatesDocumentation
  • Introduction
  • Comparison
Getting Started
  • Quickstart
  • Core Concepts
  • From Pipedrive
Connect your AI
  • Connect Claude Code
  • Connect Claude Desktop
  • Connect Codex
  • Connect Cursor
  • Connect Gemini
  • Connect ChatGPT
Integrations
  • MCP
  • Webhooks
  • OpenAPI 3.1.0
  • N8N
Self-Hosting
  • Get Started
  • Architecture & Security
Reference
  • MCP Tool Catalog
  • Filter Syntax
  • API Keys
  • Go back
  1. Introduction
  2. Connect Gemini

Connect Gemini CLI

Add Customermates to the Gemini CLI by editing ~/.gemini/settings.json.

The Gemini CLI loads MCP servers from ~/.gemini/settings.json. One file edit, then start a session and paste the setup prompt.

1. Create an API key

In Customermates: Profile → API Keys → New key. Name it for the client (e.g. Gemini CLI). Copy the 64-character string immediately. It's shown once.

2. Add the server to settings.json

Open ~/.gemini/settings.json. Merge this in, replacing YOUR_KEY:

{  "mcpServers": {    "customermates": {      "httpUrl": "https://customermates.com/api/v1/mcp",      "headers": {        "x-api-key": "YOUR_KEY"      }    }  }}

Self-hosting? Swap the URL for your instance.

If mcpServers already has entries, add customermates alongside the existing ones rather than overwriting.

3. Paste this setup prompt into your first message

Run gemini in any terminal and send this as your first message:

You are now connected to my Customermates CRM through MCP.## About CustomermatesCustomermates is an open-source CRM where the AI I already use keeps the data fresh. Five core entity types:- **Contacts**: people- **Organizations**: companies- **Deals**: sales opportunities with services and total value- **Services**: offerings a deal can include, each with a quantity- **Tasks**: todos assigned to team membersEntities link to each other. A contact belongs to one or more organizations and one or more deals. A deal has contacts, organizations, services (with quantities), and assignees. A task has assignees only. Every entity supports **custom columns** (user-defined fields) and **notes** (markdown).## Before you do anything, ask me for1. My name and role, so you can tailor your replies.2. What I usually do with my CRM, in one sentence.## Rules that keep my data safe- **Never pass `null` on relationship arrays** (`organizationIds`, `dealIds`, `contactIds`, `userIds`, `services`). Null wipes the relationship. Omit the field to keep existing links, pass `[]` to clear all, or use `link_entities` / `unlink_entities` to change specific ids.- **Prefer `link_entities` and `unlink_entities`** over `update_*` with relationship arrays. They merge instead of replacing.- **Custom fields are per-column merge**. Only the columnIds you include are changed; the rest are preserved. To clear one field pass `{ columnId, value: null }`.- **Use the correct per-type custom-column tool**. `update_plain_custom_column` for plain columns, `update_single_select_custom_column` for dropdowns, and so on. The server will tell you if you picked the wrong one.- **Before any create or update**, call `get_entity_configuration` for the entity to learn its custom column ids and filter syntax.- **Destructive actions need confirmation.** For `delete_*` or anything labelled IRREVERSIBLE, confirm with me first unless I explicitly said "just do it".## Suggested first moves1. Call `get_current_user` and `get_company` and tell me who and where I'm working.2. Call `count_entity` for contact, organization, deal, service, and task.3. Call `list_custom_columns` so we don't recreate fields that already exist.4. Ask me what I want to work on first.## Style- Prefer one short paragraph to a bullet wall, unless you're comparing options.- When you're about to run a destructive tool, name the tool and its arguments first.- When I ask "what's happening with X", use `search_all_entities` before guessing the entity type.Ready. Please ask me what I want to focus on.

The agent will orient itself and wait for direction.

Why run Customermates in Gemini

Gemini's CLI agent sits in the same terminal where you already work. The CRM becomes another tool in the same session: log a call without switching apps, move a deal stage between commits, query who's blocked while reading a customer's repo.

Try your first real prompt

  • "Move the Acme deal to stage 'Won' and add a note that the contract was signed today."
  • "Find contacts at the org for the repo I'm currently in."
  • "Log a task to follow up on the bug report we just discussed."

Troubleshooting

SymptomFix
Server not picked upRestart gemini, confirm the JSON parses cleanly
"Invalid API key"Regenerate in Profile → API Keys
Tool calls time outSet HTTPS_PROXY in the shell you launched gemini from

Next

  • MCP tool catalog
  • Connect Claude Code
  • Connect Cursor
1. Create an API key
2. Add the server to settings.json
3. Paste this setup prompt into your first message
Why run Customermates in Gemini
Try your first real prompt
Troubleshooting
Next