Skip to content

Commit 38478de

Browse files
committed
chore: improve docs formatting
1 parent 88a153e commit 38478de

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,25 @@ Exercise caution and mitigate the risks by using least-privileged accounts when
2727
- Octopus Deploy API Key
2828

2929
### Command Line
30-
```
30+
```bash
3131
npx -y @octopusdeploy/mcp-server
3232
```
3333

3434
Connection details for your Octopus Deploy instance can be supplied either via the command line:
35-
```
35+
```bash
3636
npx -y @octopusdeploy/mcp-server --server-url https://your-octopus.com --api-key YOUR_API_KEY
3737
```
3838

3939
Or via environment variables:
40-
```
40+
```bash
4141
OCTOPUS_API_KEY=API-KEY
4242
OCTOPUS_SERVER_URL=https://your-octopus.com
4343
```
4444

4545
<details>
4646
<summary><b>Install via JSON config (Cursor, Claude Desktop, etc.)</b></summary>
4747

48-
```
48+
```json
4949
{
5050
"mcpServers": {
5151
"octopusdeploy": {
@@ -112,22 +112,22 @@ npx -y @octopusdeploy/mcp-server --toolsets all --read-only --server-url https:/
112112
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.
113113

114114
1. In a new folder install dependencies manually:
115-
```
115+
```bash
116116
npm install @octopusdeploy/api-client @modelcontextprotocol/sdk commander dotenv zod
117117
```
118118

119119
2. Create `.npmrc` file with the following contents:
120-
```
120+
```bash
121121
@octopusdeploy:registry=https://npm.pkg.github.com
122122
```
123123

124124
3. Install the mcp-server:
125-
```
125+
```bash
126126
npm install @octopusdeploy/mcp-server
127127
```
128128

129129
4. Run it via:
130-
```
130+
```bash
131131
npx "your/folders/full/path" -y @octopusdeploy/mcp-server
132132
```
133133

0 commit comments

Comments
 (0)