Skip to content

Commit d11e233

Browse files
committed
mcp server docs
1 parent b080023 commit d11e233

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

website/docs/advanced/mcp-server.mdx

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,23 @@ import TabItem from '@theme/TabItem';
99

1010
## Overview
1111

12-
The ConfigCat Model Context Protocol (MCP) server exposes the full power of the [Public Management API](/api/reference/configcat-public-management-api/) to AI assistants and MCP‑capable developer tools. It lets you Create, Read, Update and Delete entities (Products, Configs, Environments, Feature Flags, Segments, Tags, Webhooks, Integrations, etc.) safely and consistently.
13-
14-
> Management only. For evaluating feature flag values inside applications use the [SDKs](/sdk-reference/overview/) or the [ConfigCat Proxy](/advanced/proxy/proxy-overview/).
12+
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) is an open protocol that standardizes how applications provide context to large language models (LLMs).
13+
The ConfigCat MCP server lets you manage feature flags and configurations via the Public Management API seamlessly from AI tools.
1514

1615
## Features
1716

1817
- Complete CRUD coverage of ConfigCat management entities
19-
- Both Config (v1) and Config V2 feature flag/value endpoints
2018
- Fine‑grained membership, permission group & invitation management
2119
- Tagging, stale flag reporting, audit logs & code reference visibility
22-
- Respect for API rate limits (propagates error details back to the client)
20+
21+
## Prerequisites
22+
23+
- [Node.js](nodejs.org) version 16 or higher installed
24+
- [Public Management API basic auth credentials](https://app.configcat.com/my-account/public-api-credentials) for ConfigCat MCP server created
2325

2426
## Setup
2527

26-
Install & run via `npx` (no local clone required). Supply your Public Management API basic auth credentials (find them at https://app.configcat.com/my-account/public-api-credentials).
28+
Supply your Public Management API basic auth credentials (find them at https://app.configcat.com/my-account/public-api-credentials).
2729

2830
### Environment Variables
2931

@@ -33,11 +35,7 @@ Install & run via `npx` (no local clone required). Supply your Public Management
3335
| `CONFIGCAT_API_PASS` ||| Management API basic auth password. |
3436
| `CONFIGCAT_BASE_URL` | | `https://api.configcat.com` | Override API host (rarely needed). |
3537

36-
Keep credentials secret. Prefer using your tool's secret storage facilities over committing them.
37-
38-
## Client Configuration Examples
39-
40-
Below are quick recipes for popular MCP clients.
38+
## Client Configuration
4139

4240
<Tabs>
4341
<TabItem value="cursor" label="Cursor" default>
@@ -49,7 +47,7 @@ Below are quick recipes for popular MCP clients.
4947
```json
5048
{
5149
"mcpServers": {
52-
"configcat": {
50+
"ConfigCat": {
5351
"command": "npx",
5452
"args": ["-y", "@configcat/mcp-server"],
5553
"env": {
@@ -61,7 +59,7 @@ Below are quick recipes for popular MCP clients.
6159
}
6260
```
6361
4. Save – the server will start on demand.
64-
62+
6563
</TabItem>
6664
<TabItem value="claude" label="Claude Desktop">
6765

@@ -72,7 +70,7 @@ Below are quick recipes for popular MCP clients.
7270
```json
7371
{
7472
"mcpServers": {
75-
"configcat": {
73+
"ConfigCat": {
7674
"command": "npx",
7775
"args": ["-y", "@configcat/mcp-server"],
7876
"env": {
@@ -88,6 +86,25 @@ Below are quick recipes for popular MCP clients.
8886
</TabItem>
8987
</Tabs>
9088

89+
Replace YOUR_API_USER and YOUR_API_PASSWORD environment variables with your [Public Management API basic auth credentials](https://app.configcat.com/my-account/public-api-credentials).
90+
91+
## Interaction
92+
93+
After you install the ConfigCat MCP server in your AI client, you can prompt your agent to create or manage your feature flags and configurations.
94+
Typically you need to click Run tool or similar in your AI client to execute the result.
95+
96+
For example, you could try asking
97+
98+
> Create a boolean feature flag called "my_awesome_feature" in the "Backend" config
99+
100+
or
101+
102+
> Turn the "my_awesome_feature" flag ON in all environments
103+
104+
or
105+
106+
> Update the "my_awesome_feature” flag in dev environment so it’s only enabled for users in Canada
107+
91108
## Available Tools
92109

93110
### Membership Management
@@ -194,29 +211,14 @@ Below are quick recipes for popular MCP clients.
194211
- `update-tag`
195212
- `delete-tag`
196213

197-
### Feature Flag & Setting Values (v1 & v2)
214+
### Feature Flag & Setting Values
198215
- `get-setting-value`
199216
- `update-setting-value`
200217
- `replace-setting-value`
201218
- `get-setting-values`
202219
- `post-setting-values`
203-
- V2 variants: each tool above has a `*-v2` counterpart for Config V2
204-
205-
## API Rate Limits
206-
207-
The Public Management API enforces rate limits. The MCP server surfaces limit exceed errors directly so clients can adapt (e.g. backing off or summarizing batched operations). See [Subscription Plan Limits](/subscription-plan-limits) for general guidance.
208-
209-
## Security Note
210-
211-
Credentials grant management rights. Store them securely, do not embed them in shared config, and rotate periodically. Avoid using the MCP server from untrusted or multi‑tenant environments.
212220

213221
## See Also
214222

223+
- [ConfigCat MCP server GitHub repository](https://github.com/configcat/mcp-server)
215224
- [Management API Reference](/api/reference/configcat-public-management-api/)
216-
- [SDK Reference](/sdk-reference/overview/)
217-
- [Proxy Overview](/advanced/proxy/proxy-overview/)
218-
- [Zombie (Stale) Flags](/zombie-flags)
219-
220-
---
221-
Need another operation exposed? Let us know via the ConfigCat support channels.
222-

0 commit comments

Comments
 (0)