Search, read, create and update Vtiger CRM leads, contacts, deals, cases and more; tag records. For sales and support teams that work in Vtiger CRM on Vtiger Cloud. Hosted by usefulapi — connect from Claude, ChatGPT, Cursor, or any MCP client.
Team and Enterprise: an Owner adds the connector for the organization first.
Run this command, then run /mcp in Claude Code to log in:
Add to Cursor or add this to ~/.cursor/mcp.json:
{
"mcpServers": {
"vtiger": {
"url": "https://vtiger.usefulapi.io/mcp"
}
}
}Add to VS Code or add this to .vscode/mcp.json:
{
"servers": {
"vtiger": {
"type": "http",
"url": "https://vtiger.usefulapi.io/mcp"
}
}
}No Add custom MCP server option? It depends on your account or workspace settings: see OpenAI's guide.
Run these commands. The second one opens the login page:
Other MCP clients (Windsurf, Cline, Zed and more): add the URL as a remote MCP server (Streamable HTTP). The client then opens the login page in your browser. Do not add an Authorization header: see Before you connect.
The AI reads the module's fields and picklist values, then lists and counts leads filtered by fields such as rating, source or owner.
vtiger_describe_module vtiger_list_records vtiger_count_records
The AI finds contacts, leads or organizations by an exact email address or phone number and opens the full record.
vtiger_lookup vtiger_get_record
The AI checks the module's fields, then runs read-only SELECT queries on it, for example deals by stage or open cases of an organization, up to 100 records per call.
vtiger_describe_module vtiger_query vtiger_count_records
The AI checks the mandatory fields, creates the lead assigned to you, and tags it, for example with the name of an event.
Changes data · vtiger_describe_module vtiger_get_me vtiger_create_record vtiger_add_tags
The AI opens the record, then changes only the fields you name, such as a deal's stage or a case's status, and leaves the rest as it is. Nothing is deleted.
Changes data · vtiger_get_record vtiger_update_record
The login page asks for your Vtiger CRM address, Username and Access Key.
The address is the one in your browser when you use the CRM, for example acme.od2.vtiger.com (Vtiger Cloud). In the CRM open your profile menu → My Preferences and copy the Access Key. The key acts with that user's permissions and record visibility. Your credentials are used only to call the Vtiger API on your behalf; they are never shown to anyone.
Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Vtiger CRM address, Username and Access Key. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
Turn on the Vtiger connector, then ask in plain words. The AI picks the tools.
| Tool | Type | What it does |
|---|---|---|
vtiger_get_me | read | Get the connected user The Vtiger user the credentials belong to (id, user name, name, email). GET /me. |
vtiger_list_modules | read | List modules The CRM modules this user can access (Leads, Contacts, Accounts, Potentials, Cases, ...) with label and whether each holds records. GET /listtypes. |
vtiger_describe_module | read | Describe a module A module's fields (name, label, type, mandatory, editable, reference targets, picklist values) and whether it can be created, updated or deleted. Read this before creating or filtering. GET /describe?elementType=<module>. |
vtiger_list_records | read | List or search records Records of one module, optionally filtered (all filters AND-ed), sorted and paged. Builds a SELECT for GET /query. The vendor returns at most 100 records per call; pass next_offset as offset for the next page. Name the fields you need: a full record has 100+ fields. |
vtiger_count_records | read | Count records How many records of a module match the filters (same filters as vtiger_list_records). GET /query with count(*). |
vtiger_query | read | Run a SELECT query Run your own read-only query: SELECT <fields|*|count(*)> FROM <Module> [WHERE ...] [ORDER BY ...] [LIMIT offset,count]. One module only, no joins, no grouping brackets; at most 100 records per call. Only SELECT is accepted. GET /query. |
vtiger_get_record | read | Get a record One record with all its fields, by id (for example 4x2063). GET /retrieve?id=<id>. |
vtiger_lookup | read | Find records by email or phone Find records in one or more modules by an exact email address or phone number. GET /lookup. |
vtiger_list_related_modules | read | List related modules The modules a module can be related to (for example Accounts relate to Contacts, Potentials, Cases, Documents). GET /relatedtypes?elementType=<module>. |
vtiger_get_tags | read | Get a record's tags The tags on one record. GET /tags_retrieve?id=<id>. |
vtiger_create_record | write | Create a record WRITE: create one record in a module (a lead, contact, account, deal, case, ...). Send every mandatory field (vtiger_describe_module lists them; assigned_user_id is usually mandatory, use the id from vtiger_get_me). Returns the new record. POST /create. Not retried. |
vtiger_update_record | write | Update fields of a record WRITE: change only the named fields of an existing record (the vendor's revise call; other fields stay as they are). Returns the updated record. POST /revise. Not retried. |
vtiger_add_tags | write | Add tags to a record WRITE: add tags to one record (existing tags stay). POST /tags_add. Not retried. |
vtiger_usage_status | Usage status (free-tier meter) Report the caller's current usage: the plan, calls used this month, the limit of the plan (the free monthly cap or the Pro fair use limit), remaining, and whether the limit is reached. Read-only; does not count against the meter. | |
vtiger_request_feature | Request a missing feature Tell usefulapi that the user needs something the Vtiger tools cannot do yet (a missing tool, field or filter). Call it only when the user asks for something none of the tools can do, and tell the user that you send the request. Do not call it for errors or for normal requests. Do not include personal data, credentials or customer records. Stored with the product name and the client type (for example Claude or Cursor), without the user's account. At most 5 requests per day. Does not count against the meter. | |
vtiger_upgrade | Upgrade to Pro (unlimited*) Get Pro: unlimited tool calls (fair use limit: 10,000 a month) on Vtiger (the free tier caps monthly usage). Plans: "monthly" — $9/month; "yearly" — $90/year (2 months free). Cancel any time: Pro then runs to the end of the paid period, so it also suits a one-time job. *A fair use limit applies. For heavy use (near Pro's limit): "plus" or "plus_yearly" — Pro+, $39/month or $390/year, unlimited tool calls (fair use limit: 100,000 a month); an existing Pro subscription changes to Pro+ in place (needs confirm: true; the price difference for the rest of the period is charged at once). Otherwise returns a short link to open in your browser (it opens Stripe Checkout); after payment the account upgrades automatically. Does not count against the meter. | |
vtiger_cancel_subscription | Cancel the Pro subscription Cancel the caller's Vtiger Pro subscription at the end of the paid period (no refund for the current period; Pro continues until then, then the free tier applies). Requires confirm: true. Run vtiger_upgrade later to undo the cancel before the period ends. Does not count against the meter. |
| Plan | Price | Limit |
|---|---|---|
| Free | $0 | 50 tool calls / month |
| Proper account | $9/mo · $90/yr | Unlimited* |
*Pro fair use limit: 10,000 tool calls a month on this server. For more, write to [email protected].
Pro covers this Vtiger server only. Subscribe with vtiger_upgrade (it returns a Stripe Checkout link). Cancel any time with vtiger_cancel_subscription: Pro continues to the end of the paid period, with no refund for the current period, and running vtiger_upgrade before then undoes the cancel. Or write to [email protected].
Review leads by rating or owner. Find a customer by email or phone. Report on open deals and cases. Add a lead and tag it. Update records after a call. See what you can do for the details.
No. usefulapi is an independent service. It is not affiliated with or endorsed by Vtiger. The server calls the Vtiger API with your own Vtiger access, so it sees only the data that your account can see.
Yes. In Claude, add this server's URL as a custom connector. In ChatGPT, add it as a custom MCP server in Plugins. Then log in once. Cursor, VS Code, Claude Code and Codex work too. See the setup steps.
The login page asks for your Vtiger CRM address, Username and Access Key. See Before you connect for where to find them.
No. Add only the URL. Do not add an Authorization header or an API key to the client config. The server signs you in with OAuth: the login page asks for your Vtiger CRM address, Username and Access Key. If the config has such a header, remove it: some clients then send that header instead of the login token, and every call fails with 401.
The login stores them encrypted in the authorization grant of your connection. The server uses them to call the Vtiger API for you and to derive a private account id for usage metering. usefulapi does not show them on any page or in any reply. To stop all access, remove the connector and change or delete these credentials in Vtiger.
Yes, if you approve it. 3 of the 13 Vtiger tools can create or change data. The other 10 are marked read-only. Most MCP clients ask you to approve a tool call before it runs.
The Free plan gives 50 tool calls / month. Pro costs $9/mo or $90/yr, with unlimited tool calls (fair use limit: 10,000 tool calls a month), for this Vtiger server only. Cancel any time: Pro then runs to the end of the paid period. Run vtiger_usage_status to see how many calls you used.
Ask the AI to run vtiger_upgrade: it returns a Stripe Checkout link. To cancel, run vtiger_cancel_subscription. Pro continues to the end of the paid period.
Tell the AI what you wanted to do. It can send the request with vtiger_request_feature. We store the text with the server name, the type of AI client and the tool you tried, not with your account, and read every request when we plan new tools. You can send up to 5 requests per day.
Any client that supports remote MCP servers (Streamable HTTP) with OAuth login: Claude (web and desktop), Claude Code, ChatGPT, Codex, Cursor, VS Code, Windsurf and others.
This is a Model Context Protocol endpoint — meant to be connected from an AI client, not opened in a browser. An invalid_token response at the URL is the auth gate working as designed; clients authenticate automatically.