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
+95-3Lines changed: 95 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +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
16
***Cross-Platform:** Pre-built binaries available for Linux, macOS, and Windows.
16
17
17
18
## Getting Started
@@ -30,21 +31,112 @@ See the [Installation Guide](./docs/user/installation.md) for detailed instructi
30
31
31
32
2. **List your organizations:**
32
33
```bash
33
-
datumctl organizations list
34
+
datumctl get organizations
34
35
```
35
36
36
-
3. **Configure `kubectl` access:**
37
+
3. **Configure `kubectl` access (optional):**
37
38
Use the organization ID (or a specific project ID) from the previous step
- **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.
99
+
100
+
> [!NOTE]
101
+
> 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
+
103
+
##### Scope: project vs. organization
104
+
105
+
> [!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.
0 commit comments