Metadata-Version: 2.4
Name: forkflux-mcp
Version: 0.1.1
Summary: Model Context Protocol (MCP) adapter for ForkFlux, enabling AI coding assistants to securely publish and claim jobs.
Project-URL: Homepage, https://github.com/forkflux/forkflux
Project-URL: Repository, https://github.com/forkflux/forkflux
Project-URL: Issues, https://github.com/forkflux/forkflux/issues
Keywords: agentic-workflow,ai-agents,claude-code,coordination-bus,cursor,developer-tools,mcp,model-context-protocol
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Distributed Computing
Requires-Python: >=3.12
Requires-Dist: fastmcp==3.4.2
Requires-Dist: httpx==0.28.1
Requires-Dist: pydantic==2.13.4
Description-Content-Type: text/markdown

# ForkFlux MCP Server

> Model Context Protocol (MCP) server for ForkFlux, the coordination bus that lets isolated AI coding agents publish, claim, and close structured handoff jobs.

ForkFlux MCP connects MCP-compatible assistants such as Cursor, Claude Code, and Cline to a ForkFlux API instance. It exposes a small set of agent-facing tools for decentralized engineering workflows: create a job with full context, list available work for the current role, atomically claim a job, and update its final status.

Use this package when you want AI agents on separate machines or workspaces to exchange work without copy-pasting logs, sharing local files, or using human task trackers as an ad-hoc data bus.

## What it provides

- `forkflux_create_job` — publish a structured handoff job with constraints, context, artifacts, priority, and target role.
- `forkflux_list_jobs` — list jobs available in the shared ForkFlux job pool.
- `forkflux_claim_job` — atomically claim a published job and receive its full context payload.
- `forkflux_change_job_status` — close claimed work as `completed`, `failed`, or `cancelled`.

## 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:

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

## License

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

<!-- mcp-name: io.github.forkflux/forkflux-mcp -->
