Skip to content

Commit b464b81

Browse files
committed
chore: update installation instructions
1 parent a07f7ba commit b464b81

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ Use the `--toolsets` parameter to enable specific groups of tools:
3333

3434
```bash
3535
# Enable all toolsets (default)
36-
npm start
36+
npx -y @octopusdeploy/mcp-server
3737

3838
# Enable only specific toolsets
39-
npm start -- --toolsets projects,deployments
39+
npx -y @octopusdeploy/mcp-server --toolsets projects,deployments
4040

4141
# Enable all toolsets explicitly
42-
npm start -- --toolsets all
42+
npx -y @octopusdeploy/mcp-server --toolsets all
4343
```
4444

4545
Available toolsets:
@@ -57,20 +57,44 @@ The server runs in read-only mode by default for security. All current tools are
5757

5858
```bash
5959
# Run in read-only mode (default)
60-
npm start -- --read-only
60+
npx -y @octopusdeploy/mcp-server --read-only
6161

6262
# Disable read-only mode (currently no effect as all tools are read-only)
63-
npm start -- --read-only=false
63+
npx -y @octopusdeploy/mcp-server --read-only=false
6464
```
6565

6666
#### Complete Examples
6767

6868
```bash
6969
# Development setup with only core and project tools
70-
npm start -- --toolsets core,projects --server-url https://your-octopus.com --api-key YOUR_API_KEY
70+
npx -y @octopusdeploy/mcp-server --toolsets core,projects --server-url https://your-octopus.com --api-key YOUR_API_KEY
7171

7272
# Full production setup with all tools
73-
npm start -- --toolsets all --read-only --server-url https://your-octopus.com --api-key YOUR_API_KEY
73+
npx -y @octopusdeploy/mcp-server --toolsets all --read-only --server-url https://your-octopus.com --api-key YOUR_API_KEY
74+
```
75+
76+
### Running from Github Registry
77+
78+
This is a temporary workaround until we start publishing preview versions to the public npm registry. The following is assuming you are already signed in to the github registry.
79+
80+
1. In a new folder install dependencies manually:
81+
```
82+
npm install @octopusdeploy/api-client @modelcontextprotocol/sdk commander dotenv zod
83+
```
84+
85+
2. Create `.npmrc` file with the following contents:
86+
```
87+
@octopusdeploy:registry=https://npm.pkg.github.com
88+
```
89+
90+
3. Install the mcp-server:
91+
```
92+
npm install @octopusdeploy/mcp-server
93+
```
94+
95+
4. Run it via:
96+
```
97+
npx -y @octopusdeploy/mcp-server
7498
```
7599

76100
## 🔨 Tools

0 commit comments

Comments
 (0)