Skip to content

Commit 2035df0

Browse files
facundofariasclaude
andcommitted
docs: Clarify read-only mode is optional and deployments are allowed by default
Reorganized documentation to emphasize: - Deployments are allowed by default (no configuration needed) - Read-only mode is completely optional - Full functionality works out of the box - Read-only mode is a safety feature for users who want extra protection This makes it clear that the feature works properly but isn't the default behavior. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 2b730d7 commit 2035df0

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -407,18 +407,22 @@ npm run test:ui # Interactive UI for debugging
407407

408408
### Read-Only Mode (Optional)
409409

410-
The DeployHQ MCP Server supports an optional **read-only mode** that can be enabled to prevent deployment creation when using AI assistants.
410+
**By default, the MCP server allows all operations, including creating deployments.** This is the recommended configuration for most users.
411411

412-
**Default Behavior:**
413-
- ✅ All operations work by default (list, get, create)
414-
- ✅ Deployments can be created through AI assistants
415-
- ⚠️ Consider enabling read-only mode in production environments
412+
For users who want additional protection against accidental deployments, the server includes an **optional read-only mode** that can be enabled to block deployment creation.
416413

417-
**When to enable read-only mode:**
418-
- You want to prevent accidental deployments via AI
419-
- You're connecting to production environments
420-
- You want an extra layer of protection
414+
**Default Behavior (No Configuration Needed):**
415+
- ✅ Deployments are **allowed by default**
416+
- ✅ All operations work: list, get, and create deployments
417+
- ✅ Full functionality out of the box
418+
419+
**When you might want to enable read-only mode:**
420+
- You want extra protection against accidental deployments via AI
421+
- You're connecting to production environments and want an additional safety layer
421422
- You only need read access to monitor deployments
423+
- You're still testing the integration and want to be cautious
424+
425+
**Important:** Read-only mode is **completely optional**. The server works fully without it.
422426

423427
**How to enable read-only mode:**
424428

docs/USER_GUIDE.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -585,16 +585,26 @@ Choose the scope that best fits your needs. For most users, `--scope user` or us
585585

586586
### Read-Only Mode (Optional)
587587

588-
The DeployHQ MCP Server supports an optional **read-only mode** that can be enabled to prevent deployment creation when using AI assistants.
588+
**By default, the MCP server allows all operations, including creating deployments.** This is the recommended configuration for most users who want full functionality.
589589

590-
**Default Behavior:**
591-
- ✅ All operations work by default (list, get, create deployments)
592-
- ✅ Deployments can be created through AI assistants
593-
- ⚠️ Consider enabling read-only mode in production environments for extra protection
590+
For users who want additional protection against accidental deployments, the server includes an **optional read-only mode** that can be enabled to block deployment creation while still allowing read operations.
591+
592+
**Default Behavior (No Configuration Needed):**
593+
- ✅ Deployments are **allowed by default**
594+
- ✅ All operations work: list projects, get details, and create deployments
595+
- ✅ Full functionality out of the box
596+
597+
**When you might want to enable read-only mode:**
598+
- You want extra protection against accidental deployments via AI
599+
- You're connecting to production environments and want an additional safety layer
600+
- You only need read access to monitor deployments
601+
- You're still testing the integration and want to be cautious
602+
603+
**Important:** Read-only mode is **completely optional**. The server works fully without it.
594604

595605
**Enabling Read-Only Mode:**
596606

597-
If you want to prevent deployments through the MCP server (read-only access), you can enable read-only mode in two ways:
607+
If you want to prevent deployments through the MCP server, you can enable read-only mode in two ways:
598608

599609
**Method 1: Environment Variable**
600610
```json

0 commit comments

Comments
 (0)