Opscotch Workspace

@opscotch/oms-workspace is an npm package that lets MCP clients connect to the Opscotch Workspace MCP server.

Requirements

• Node.js 18 or later
• Docker with Docker Compose V2
• Legal acceptance - Accept the Opscotch legal terms and use the resulting token as OPSCOTCH_LEGAL_ACCEPTED

Quick Start

1. Install

This creates configuration in ~/.oms-workspace/ and pulls Docker images. Required environment variables:

OPSCOTCH_LEGAL_ACCEPTED=<token> \
OPSCOTCH_WORKSPACE_PATH=<path> \
npx -y @opscotch/oms-workspace install

Where:

• OPSCOTCH_LEGAL_ACCEPTED - Token from accepting Opscotch legal terms
• OPSCOTCH_WORKSPACE_PATH - Root path accessible to the workspace (e.g., /home/user/dev/opscotch)

2. Configure Your MCP Client

Add this to your MCP client settings (e.g., Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "oms-workspace": {
      "command": "npx",
      "args": ["-y", "@opscotch/oms-workspace", "run"]
    }
  }
}

3. Use

Start your MCP client. The workspace will start automatically when you use tools prefixed with olds_ or og_.

Available Tools

• olds_... - Local development tools
• og_... - Public guidance tools

Commands

oms-workspace install   # Create config and pull Docker images
oms-workspace run       # Start MCP stdio wrapper (called by MCP client)
oms-workspace stop      # Stop runtime and Docker containers
oms-workspace doctor    # Check system requirements

Configuration Files

Located in ~/.oms-workspace/:

~/.oms-workspace/runtime.json        # Connection metadata
~/.oms-workspace/runtime.pid         # Runtime process ID
~/.oms-workspace/runtime.log         # Runtime diagnostics
~/.oms-workspace/docker-compose.yml  # Docker Compose config
~/.oms-workspace/.env                # Environment variables

Troubleshooting

Check system requirements

oms-workspace doctor

View backend logs

docker compose -p oms-workspace -f ~/.oms-workspace/docker-compose.yml logs --no-color --tail=100

Stop everything

oms-workspace stop

License

This package is free to use, but use is conditioned on agreement to the Opscotch legal terms:

• https://www.opscotch.co/legal

The packaged license notice is included in LICENSE.txt.

Versions

0.1.6

• Upgrades to opscotch 3.1.6
• Removes legacy licensing requirements

0.1.1

• Initial npm release
• CLI tool: opscotch-workspace
• Commands: install, run, stop, doctor, proxy, runtime
• Docker Compose backed MCP stdio proxy
• Connects to local development and public guidance MCP backends