Skip to content

quickstart.md

Latest commit

 

History

History
85 lines (57 loc) · 1.76 KB

quickstart.md

File metadata and controls

85 lines (57 loc) · 1.76 KB
Raw

Quickstart

Install the published command from PyPI:

curl -fsSL https://raw.githubusercontent.com/xyTom/coding-tools-mcp/main/scripts/install.sh | bash

Install and start local Streamable HTTP against a workspace:

curl -fsSL https://raw.githubusercontent.com/xyTom/coding-tools-mcp/main/scripts/install.sh \
  | bash -s -- --start --workspace /path/to/repo

Install and expose a read-only bearer-token tunnel:

curl -fsSL https://raw.githubusercontent.com/xyTom/coding-tools-mcp/main/scripts/install.sh \
  | bash -s -- --tunnel cloudflared --auto-install-tunnel --workspace /path/to/repo

Or, from this checkout:

scripts/install.sh

Run the published package without a persistent install:

uvx coding-tools-mcp --workspace .

Use stdio for MCP clients:

uvx coding-tools-mcp --stdio --workspace /path/to/repo

When working from this checkout instead of a published package, install the runtime in editable mode:

python -m pip install -e ".[dev]"

Start Streamable HTTP against a workspace:

coding-tools-mcp --workspace /path/to/repo --host 127.0.0.1 --port 8765

Endpoint:

http://127.0.0.1:8765/mcp

Start stdio:

coding-tools-mcp --stdio --workspace /path/to/repo

Run the acceptance gate:

make compliance

For local trace debugging:

CODING_TOOLS_MCP_TRACE=1 coding-tools-mcp --workspace /path/to/repo

Trace JSON lines are written to stderr.

If the MCP client cannot show permission prompts and you intentionally want permission-gated commands to run:

coding-tools-mcp --dangerously-skip-all-permissions --workspace /path/to/repo

Use this only with trusted workspaces and trusted clients. It does not remove workspace path boundaries.