Skip to content

xrmcp/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

xrmcp-cli

A Go CLI for managing and running the xrMCP runtime server.

Installation

macOS

Homebrew

brew tap xrmcp/homebrew-tap
brew install xrmcp

Manual install

Download the matching macOS archive from GitHub Releases, extract it, and move xrmcp into a directory on your PATH.

Verify downloads with sha256sums.txt.

Linux

Homebrew

brew tap xrmcp/homebrew-tap
brew install xrmcp

Debian/Ubuntu

Download the matching .deb package from GitHub Releases and install it:

sudo dpkg -i xrmcp_<version>_amd64.deb

Install script

curl -fsSL https://raw.githubusercontent.com/xrmcp/cli/main/install.sh | sh

Pin a specific version:

curl -fsSL https://raw.githubusercontent.com/xrmcp/cli/main/install.sh | sh -s -- --version v0.1.0

Manual install

Download the matching Linux .tar.gz, extract it, and move xrmcp into a directory on your PATH.

Verify downloads with sha256sums.txt.

Windows

Scoop

scoop bucket add xrmcp https://github.com/xrmcp/scoop-bucket
scoop install xrmcp

Manual install

Download the matching Windows .zip from GitHub Releases, extract it, and place xrmcp.exe on your PATH.

Verify downloads with sha256sums.txt.

Build from source

git clone https://github.com/xrmcp/cli xrmcp-cli
cd xrmcp-cli
go build -o xrmcp .

Commands

xrmcp server start

Start the xrMCP runtime server.

xrmcp server start [flags]
Flag Short Default Description
--transport -t stdio Transport mode: stdio or http
--port -p 7373 Port to listen on
--store -s Path to the tool registry JSON file
--env .env Path to a .env file to load (silently skipped if missing)

Flags take precedence over values in the .env file. Supported env vars: XRMCP_TRANSPORT, XRMCP_ADDR, XRMCP_STORE_PATH.

Examples:

# stdio mode (default) — HTTP REST on :7373, MCP over stdin/stdout
xrmcp server start

# HTTP mode — REST + MCP Streamable HTTP on :8080
xrmcp server start -t http -p 8080

# Load custom .env and persist tools
xrmcp server start --env /path/to/.env -s /path/to/tools.json

xrmcp tool ls

List tools installed on the running server.

xrmcp tool ls [--url <base-url>]

Env var fallback: XRMCP_SERVER_URL (default: http://localhost:7373).


xrmcp tool install <manifest>

Register a tool from a local manifest JSON file or registry identifier.

xrmcp tool install ./registry/tools/my-tool.xrmcp.json

You can also install directly from the official registry:

xrmcp tool install jira/get_jira_ticket

The installer supports interactive config prompting based on configSchema.


xrmcp tool search <keyword>

Search the official registry index without downloading every manifest.

xrmcp tool search jira
xrmcp tool search project

xrmcp tool uninstall <name>

Uninstall a tool by name.

xrmcp tool uninstall my-tool

Environment variables

Variable Description
XRMCP_TRANSPORT stdio or http
XRMCP_ADDR Listen address, e.g. :7373
XRMCP_STORE_PATH Path to the tool registry JSON file
XRMCP_SERVER_URL Base URL for tool subcommands (default http://localhost:7373)

Release automation

Release packaging is driven by:

  • .goreleaser.yml
  • .github/workflows/ci.yml
  • .github/workflows/release.yml

Normal CI:

  • runs go test ./...
  • validates the GoReleaser configuration with goreleaser check

Tagged releases:

  • trigger on tags like v0.1.0
  • run tests
  • build the supported OS/arch matrix
  • package release archives
  • generate sha256sums.txt
  • generate Linux .deb packages
  • publish artifacts to GitHub Releases

Maintainer notes

Homebrew and Scoop publishing require external repositories.

Publishing repos:

  • xrmcp/homebrew-tap
  • xrmcp/scoop-bucket

Current behavior:

  • release archives, checksums, and .deb packages are produced and published by GoReleaser
  • Homebrew and Scoop definitions are generated by GoReleaser
  • Homebrew and Scoop publication are handled through separate tap and bucket repositories

About

xrMCP CLI

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors