Skip to content

A full-featured CRM built with React, shadcn/ui, and Supabase.

Add MCP server documentation

fzaninottodecadace7db2
diff --git a/doc/astro.config.mjs b/doc/astro.config.mjs
index 1ec5e7e3..ff69927d 100644
--- a/doc/astro.config.mjs
+++ b/doc/astro.config.mjs
@@ -2,6 +2,7 @@
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import tailwindcss from "@tailwindcss/vite";
+import { server } from "typescript";
// https://astro.build/config
export default defineConfig({
@@ -83,7 +84,13 @@ export default defineConfig({
},
{
label: "Users Documentation",
- autogenerate: { directory: "users" },
+ items: [
+ "users/import-contacts",
+ "users/merging-contacts",
+ "users/user-management",
+ "users/inbound-email",
+ "users/mcp-server",
+ ],
},
{
label: "Developers Documentation",
diff --git a/doc/src/content/docs/users/mcp-server.mdx b/doc/src/content/docs/users/mcp-server.mdx
new file mode 100644
index 00000000..00ed7a37
--- /dev/null
+++ b/doc/src/content/docs/users/mcp-server.mdx
@@ -0,0 +1,41 @@
+---
+title: MCP Server
+description: This document explains how to use MCP Server in Atomic CRM.
+---
+
+You can interact with the data stored in your Atomic CRM instance using an AI assistant like Claude Desktop or Visual Studio Code, thanks to the MCP Server.
+
+![MCP Server](../../images/mcp-server.png)
+
+## Installation
+
+The MCP server is a third-party application that you need to install and run on your own infrastructure. You can find the installation instructions in the Atomic CRM MCP Server GitHub repository at https://github.com/marmelab/atomic-crm-mcp.
+
+## Adding Atomic CRM as a MCP Server
+
+The MCP server is currently available for the following AI assistants:
+
+- Visual Studio Code
+- Claude Desktop
+- Claude Code
+- ~~Claude Mobile~~
+- ~~ChatGPT Desktop~~
+- ~~ChatGPT Mobile~~
+
+Refer to the [MCP Server documentation](https://github.com/marmelab/atomic-crm-mcp#adding-the-mcp-server-to-visual-studio-code) for detailed instructions concerning each AI assistant.
+
+## Usage
+
+Once the MCP server is enabled and authenticated, you can start asking questions about your Atomic CRM data directly from your AI assistant. For example, you can ask:
+
+- "Can you remind me of the pending tasks for the hot contacts?"
+- "List all open deals with a value greater than $10,000."
+- "What are the top 5 companies by revenue?"
+
+The MCP server will process your queries and return the relevant data from your Atomic CRM instance.
+
+You can also perform actions such as creating new contacts, updating deal statuses, or generating reports using natural language commands.
+
+- "Create a new contact for [email protected]"
+- "The deal #1234 has been won. Update its status."
+- "Add a follow-up task about Jeremiah: I should call him next week."
\ No newline at end of file
diff --git a/doc/src/content/images/mcp-server.png b/doc/src/content/images/mcp-server.png
new file mode 100644
index 00000000..3d292d11
Binary files /dev/null and b/doc/src/content/images/mcp-server.png differ