You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-13Lines changed: 24 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Use `datumctl` to manage your Datum Cloud resources, authenticate securely, and
12
12
***Multi-User Support:** Manage credentials for multiple Datum Cloud user accounts.
13
13
***Resource Management:** Interact with Datum Cloud resources (e.g., list organizations).
14
14
***Kubernetes Integration:** Seamlessly configure `kubectl` to use your Datum Cloud credentials for accessing Kubernetes clusters.
15
-
***MCP Server (optional):** Start an MCP server (`datumctl mcp`) for Datum Cloud so AI agents (e.g., Claude) can discover resources, inspect schemas, and validate manifests via server-side dry-run.
15
+
***MCP Server (optional):** Start an MCP server (`datumctl mcp`) for Datum Cloud so AI agents (e.g., Claude) can discover resources, inspect schemas, validate manifests, and perform CRUD operations via server-side dry-run.
16
16
***Cross-Platform:** Pre-built binaries available for Linux, macOS, and Windows.
17
17
18
18
## Getting Started
@@ -46,9 +46,9 @@ See the [Installation Guide](./docs/user/installation.md) for detailed instructi
46
46
```
47
47
Now you can use `kubectl` to interact with your Datum Cloud control plane.
48
48
49
-
### Project setup (required for MCP)
49
+
### MCP Setup
50
50
51
-
MCP typically targets a **project** control plane. You need at least one project and its **Project ID** (the Kubernetes resource name).
51
+
MCP can target either an **organization** or **project** control plane. For maximum flexibility, we recommend starting with an organization context.
- **Safety:** All write operations default to dry-run mode; use `dryRun: false` to apply changes
102
+
95
103
##### Startup & safety
96
104
97
105
- **Preflight:** On startup, `datumctl mcp` verifies connectivity and auth by calling Kubernetes discovery (e.g., `GET /version`). If this check fails, the server exits.
98
-
- **Read-only:** All operations are validation-only and use server-side dry-run (`dryRun=All`). No resources are created, modified, or deleted.
106
+
- **Dry-run by default:** All write operations use server-side dry-run (`dryRun=true`) by default for safety.
99
107
100
108
> [!NOTE]
101
109
> The MCP server builds its own Kubernetes connection for the selected Datum context; it does **not** depend on your local kubeconfig or `--kube-context`. Provide either `--organization` or `--project`.
102
110
103
-
##### Scope: project vs. organization
111
+
##### Scope: organization vs. project
104
112
105
113
> [!IMPORTANT]
106
-
>Most Kubernetes operations exposed via MCP (e.g., CRD discovery and server-side dry-run validation) are **project-scoped**.
107
-
>Running MCP at **organization**scope will typically show only org-level resources; attempts to validate project-level CRDs may return**HTTP 401/Forbidden** or appear missing.
114
+
>**Organization scope** provides access to all projects within the organization and allows switching between them using `change_context`.
115
+
>**Project scope**provides direct access to project-specific resources but limits visibility to that single project.
0 commit comments