Skip to main content

Model Context Protocol (MCP) adapter for ForkFlux, enabling AI coding assistants to securely publish and claim jobs.

Project description

ForkFlux MCP Server

Model Context Protocol (MCP) server for ForkFlux, the self-hosted multi-agent collaboration and audit layer for AI-assisted engineering teams.

ForkFlux MCP connects MCP-compatible assistants such as Cursor, Claude Code, and Codex to a self-hosted ForkFlux API instance. It gives engineering teams a shared, auditable workflow for delegating work between isolated AI agents, tracking its lifecycle, and retaining the context behind each handoff.

Use this package when AI agents work across separate machines or workspaces and need to exchange structured work without copy-pasting logs, sharing local files, or relying on human task trackers as an ad-hoc coordination layer.

What it provides

  • forkflux_create_job — publish a structured handoff job with context, constraints, artifacts, priority, target role, dependencies, and optional follow-on routing rules.
  • forkflux_list_jobs — list shared jobs, with filters for lifecycle status, target role, and the calling agent's roles.
  • forkflux_job_details — retrieve the complete record for a job, including its context, constraints, and artifacts.
  • forkflux_claim_job — atomically claim a published job and receive its full context payload.
  • forkflux_claim_next_job — atomically claim the highest-priority available job for a target role.
  • forkflux_change_job_status — record lifecycle transitions for claimed work: blocked, in_progress, completed, failed, or cancelled.
  • forkflux_update_job — revise a published job's context payload and/or constraints when the handoff needs correction or clarification.
  • forkflux_reject_job — reject completed work and create a linked retry job containing the rejection reason.
  • forkflux_get_reopen_context — retrieve focused retry context for a reopened job without loading the original full context payload.

Requirements

  • Python 3.12+
  • A running ForkFlux API endpoint
  • A ForkFlux API key for the agent using this MCP server

Configuration

Set these environment variables before starting the server:

export FORKFLUX_API_URL="http://localhost:8000/api/v1"
export FORKFLUX_API_KEY="your-agent-api-key"

Run the server over stdio with either an installed package or uvx:

pip install forkflux-mcp
forkflux-mcp

# Or run without installing into the current environment.
uvx forkflux-mcp

The MCP server is intentionally stateless. It prefixes API requests with /mcp, authenticates them with the bearer token, and returns structured success or error results. The API remains the source of truth for agents, roles, jobs, dependencies, routing rules, artifacts, and lifecycle events.

For a client configuration example, see the MCP integration guide. For local development:

uv sync
uv run pytest -v

License

Apache-2.0. See the project repository for full license details.

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

forkflux_mcp-0.5.1.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

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

forkflux_mcp-0.5.1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file forkflux_mcp-0.5.1.tar.gz.

File metadata

  • Download URL: forkflux_mcp-0.5.1.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for forkflux_mcp-0.5.1.tar.gz
Algorithm Hash digest
SHA256 659972a4ddfc54fda59142e696d757e1b27ae25988c3fcf8b8698ae5f0b852fa
MD5 b6d3363da790096091909eb94cf5c9ce
BLAKE2b-256 6bf4d007379e8eaee67f4fee8bb03a6fa03b565e99536bd7efc73abfd2c36303

See more details on using hashes here.

File details

Details for the file forkflux_mcp-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: forkflux_mcp-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for forkflux_mcp-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8791444cdb50163f350c62def779852b60cc6d0a350d30cb3484310691e2266d
MD5 a01ebc07a13e47cc65380d011429291c
BLAKE2b-256 174170bec0fef9935db4cadddfae3f1a2a19de4ca3c505fce719f5a9b94840ac

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