Skip to main content

A MCP server for Hex

Project description

hex-mcp MCP server

A MCP server for Hex

Components

Resources

The server implements a simple note storage system with:

  • Custom note:// URI scheme for accessing individual notes
  • Each note resource has a name, description and text/plain mimetype

Prompts

The server provides a single prompt:

  • summarize-notes: Creates summaries of all stored notes
    • Optional "style" argument to control detail level (brief/detailed)
    • Generates prompt combining all current notes with style preference

Tools

The server implements multiple tools to interact with the Hex API:

  • list_hex_projects: Lists available Hex projects
  • search_hex_projects: Search for Hex projects by pattern
  • get_hex_project: Get detailed information about a specific project
  • get_hex_run_status: Check the status of a project run
  • get_hex_project_runs: Get the history of project runs
  • run_hex_project: Execute a Hex project
  • cancel_hex_run: Cancel a running project

Installation

pip install hex-mcp

For development features:

pip install "hex-mcp[dev]"

Configuration

The Hex MCP server requires two environment variables:

  • HEX_API_KEY: Your Hex API key
  • HEX_API_URL: The Hex API base URL

You can set these in a .env file or pass them via command line arguments.

CLI Usage

The CLI uses Typer to provide a modern command-line interface:

hex-mcp [OPTIONS] COMMAND [ARGS]...

Commands

  • run: Run the MCP server normally (default if no command is specified)
  • dev: Run in development mode with the MCP Inspector

Global Options

These options apply to all commands:

  • --api-key TEXT: Set the Hex API key (overrides HEX_API_KEY environment variable)
  • --api-url TEXT: Set the Hex API URL (overrides HEX_API_URL environment variable)
  • --server-name TEXT: Set a custom name for the MCP server (default: "Hex MCP Server")
  • -v, --verbose: Enable verbose logging
  • --version: Show the version of hex-mcp and exit
  • --help: Show help message and exit

Command-specific Options

dev

  • --port INTEGER: Set the port for the development server (default: 8765)

Examples

Run the server with environment variables from .env file:

hex-mcp run
# or just
hex-mcp

Run with command line configuration:

hex-mcp --api-key your_api_key --api-url https://hex-api.example.com run

Run in development mode:

hex-mcp --verbose dev --port 9000

Show version:

hex-mcp --version

Show help:

hex-mcp --help
hex-mcp dev --help

Quickstart

Install

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json On Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration ``` "mcpServers": { "hex-mcp": { "command": "hex-mcp", "args": [ "--api-key", "your_api_key", "--api-url", "your_api_url", "run" ] } } ```
Published Servers Configuration ``` "mcpServers": { "hex-mcp": { "command": "hex-mcp", "env": { "HEX_API_KEY": "your_api_key", "HEX_API_URL": "your_api_url" } } } ```

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, use our built-in development mode:

hex-mcp dev

This will start the MCP Inspector web interface which allows you to:

  • See real-time requests and responses
  • Test tools and resources
  • Debug server behavior

For manual inspector usage:

npx @modelcontextprotocol/inspector hex-mcp

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hex_mcp-0.1.7.tar.gz (17.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hex_mcp-0.1.7-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file hex_mcp-0.1.7.tar.gz.

File metadata

  • Download URL: hex_mcp-0.1.7.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for hex_mcp-0.1.7.tar.gz
Algorithm Hash digest
SHA256 d30c4217ad815f07bf7e6b0611b23496599b18a23f98aa30ee9e3e03a4161254
MD5 8953d935734c8223068eaab01d3d03f5
BLAKE2b-256 de37c689ab6cf35e381cbf60e8ef8474b3a2f5021dc731d519559b1e820f0c94

See more details on using hashes here.

File details

Details for the file hex_mcp-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: hex_mcp-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for hex_mcp-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 0ba26cbd47ace5affa8e9d70767380b53bdcf60efc629256af0d7a387ab6254a
MD5 35e7144fcc19271dd38bb20a316cda0b
BLAKE2b-256 f4241eccf491ae1b5f27a31171ab01cc5027e13f4585cf546c5497c2a20f46ac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page