Skip to content

Installation

mcp-compressor ships three public surfaces:

  • a CLI named mcp-compressor,
  • SDKs for Python, TypeScript, and Rust,
  • generated clients for shell, Python, and TypeScript.

Install the SDK

pip install mcp-compressor

Then import:

from mcp_compressor import CompressorClient

npm install @atlassian/mcp-compressor

Then import:

import { CompressorClient } from "@atlassian/mcp-compressor";

Add the public Rust crate to your project:

mcp-compressor = "0.1"

Then import:

use mcp_compressor::sdk::{CompressorClient, ServerConfig};

Install the CLI

Install from crates.io:

cargo install mcp-compressor
mcp-compressor --help

You can also download a release artifact named for your platform, place it on PATH, and verify:

mcp-compressor --help

From source:

cargo build -p mcp-compressor --bin mcp-compressor --release
./target/release/mcp-compressor --help

pip install mcp-compressor
mcp-compressor --help

The wrapper delegates to the Rust binary. Set MCP_COMPRESSOR_BINARY if the binary is not on PATH.

npm install -g @atlassian/mcp-compressor
mcp-compressor --help

The wrapper also delegates to the Rust binary. Set MCP_COMPRESSOR_BINARY to override binary discovery.

Development from source

Use these commands when working on this repository.

cd python/mcp-compressor
uv sync --group dev
uv run maturin develop
uv run pytest -q tests

The dev group is only needed for contributor tooling such as maturin, pytest, ruff, and ty.

cd typescript
bun install
bun run build
bun run build:native
bun run check

cargo check -p mcp-compressor
cargo test -p mcp-compressor-core --tests --no-run

Verify installation

mcp-compressor --help

from mcp_compressor import CompressorClient

assert CompressorClient is not None

import { CompressorClient } from "@atlassian/mcp-compressor";

console.log(typeof CompressorClient);

cargo check -p mcp-compressor