diff --git a/README.md b/README.md index ea579ed..850ed78 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ This documentation covers: - **Interactive API Reference** - Live testing environment with OpenAPI 3.0 - **Authentication & Security** - API key management and security best practices - **Rate Limiting** - Usage guidelines and limits +- **Model Context Protocol (MCP)** - Secure, standardized access for AI models and agents to connect with your accounting data - **Webhooks** - Real-time notifications (coming soon) - **Error Handling** - Comprehensive error codes and troubleshooting diff --git a/docs.json b/docs.json index f20dcde..55e048a 100644 --- a/docs.json +++ b/docs.json @@ -26,6 +26,13 @@ "api-reference/authentication" ] }, + { + "group": "Model Context Protocol", + "pages": [ + "mcp", + "mcp-tools" + ] + }, { "group": "Formation API", "pages": [ diff --git a/index.mdx b/index.mdx index bb9e8cb..f662cbd 100644 --- a/index.mdx +++ b/index.mdx @@ -11,7 +11,7 @@ Welcome to the official Clemta API reference documentation. Our APIs allow you t ## Available APIs - + Programmatically initiate company formations and check their status @@ -22,6 +22,13 @@ Welcome to the official Clemta API reference documentation. Our APIs allow you t > Manage invoices, expenses, and other accounting functions + + Connect AI models and agents to your Clemta data + ## Authentication diff --git a/mcp-tools.mdx b/mcp-tools.mdx new file mode 100644 index 0000000..4b60463 --- /dev/null +++ b/mcp-tools.mdx @@ -0,0 +1,64 @@ +--- +title: "MCP Tools" +description: "Explore the available tools in Clemta's MCP server, including authentication, company, and contact management." +--- + +# MCP Tools Reference + +Clemta MCP server provides tools for accessing user, company, and contact data. +Each tool is authenticated and returns standardized error responses. + +--- + +## Authentication + +### `whoami` + +Returns detailed information about the authenticated user. + +--- + +## Company Management + +### `view_companies` + +Retrieves all companies associated with the authenticated user. + +### `view_company` + +Retrieves detailed information about a specific company. + +--- + +## Contact Management + +### `view_contacts` + +Lists all contacts for a specific company. + +### `view_contact` + +Retrieves detailed information about a specific contact. + +### `create_contact` + +Creates a new contact for a company. + +### `update_contact` + +Updates an existing contact for a company. + +### `delete_contact` + +Deletes (deactivates) a contact for a company. + +--- + +## Error Handling + +All tools may return standardized error responses: + +- **Authentication errors** – invalid or missing credentials. +- **Invalid parameters** – request contains unsupported or malformed values. +- **Resource not found** – requested item does not exist. +- **Permission denied** – insufficient access rights. diff --git a/mcp.mdx b/mcp.mdx new file mode 100644 index 0000000..f982618 --- /dev/null +++ b/mcp.mdx @@ -0,0 +1,108 @@ +--- +title: "Model Context Protocol (MCP)" +description: "Use Clemta's MCP server to connect AI models and agents with your accounting data." +--- + +# Introduction + +Clemta’s MCP server provides a secure and standardized way for AI models and agents to connect with your accounting data. +It simplifies data access and management through ready-to-use tools. + +--- + +## Overview + +- Built on the **authenticated remote MCP specification** +- Hosted and managed by Clemta +- Provides tools to interact with **company records, contacts, and resources** + +--- + +## Connection Details + +Clemta’s MCP server uses **Server-Sent Events (SSE)** and **OAuth 2.1** with dynamic client registration. + +**SSE Endpoint:** + +```bash +https://mcp.clemta.com/sse +``` + +--- + +## Setup Guides + +### Claude + +#### Team & Enterprise (Claude.ai) + +1. Open **Settings** in the sidebar (web or desktop). +2. Go to **Integrations** → **Add more**. +3. Enter: + - **Integration name:** Clemta + - **Integration URL:** `https://mcp.clemta.com/sse` +4. Enable the integration for new chats. + +#### Free & Pro (Claude Desktop App) + +1. Open the config file: + + ```bash + ~/Library/Application Support/Claude/claude_desktop_config.json + ``` + +2. Add this snippet, then restart Claude Desktop: + + ```json + { + "mcpServers": { + "clemta": { + "command": "npx", + "args": ["-y", "mcp-remote", "https://mcp.clemta.com/sse"] + } + } + } + ``` + +--- + +### Cursor + +Open the [MCP Tools page](https://docs.cursor.com/en/welcome) in Cursor and configure Clemta’s MCP server with the SSE URL. + +--- + +### Visual Studio Code + +1. Press **CTRL/CMD + P** and type `MCP: Add Server`. +2. Select **Command (stdio)**. +3. Enter the command: + + ```bash + npx mcp-remote https://mcp.clemta.com/sse + ``` + +4. Name the server **Clemta**. +5. Start it via `MCP: List Servers` → **Clemta** → **Start Server**. + +--- + +### Other MCP-Compatible Tools + +Use the following configuration: + +- **Command:** `npx` +- **Arguments:** `-y mcp-remote https://mcp.clemta.com/sse` +- **Environment:** none + +--- + +## Authentication + +When connecting, Clemta prompts you to authenticate via **OAuth 2.1**, ensuring secure and authorized access to your data. + +--- + +## Available Tools + +See the [MCP Tools Reference](/mcp-tools) for details on supported tools and functionality.