Metadata-Version: 2.4
Name: agentsflow
Version: 0.0.4
Summary: Add your description here
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: agent-client-protocol>=0.6.2
Requires-Dist: click>=8.1.7
Requires-Dist: fastmcp>=2.13.0.2
Requires-Dist: gitpython>=3.1.43
Requires-Dist: jira>=3.8.0
Requires-Dist: logfire>=4.14.2
Requires-Dist: pydantic-ai-slim[openai,temporal]>=1.9.1
Requires-Dist: pydantic-settings>=2.4.0
Requires-Dist: pygithub>=2.5.0
Requires-Dist: python-dotenv>=1.0.1
Requires-Dist: rich>=13.7.0
Requires-Dist: temporalio>=1.18.0
Provides-Extra: dev
Requires-Dist: mike>=2.1.1; extra == 'dev'
Requires-Dist: mkdocs-autorefs>=1.0.1; extra == 'dev'
Requires-Dist: mkdocs-material>=9.5.0; extra == 'dev'
Requires-Dist: mkdocs>=1.6.0; extra == 'dev'
Requires-Dist: mkdocstrings[python]>=0.24.3; extra == 'dev'
Requires-Dist: mypy>=1.0.0; extra == 'dev'
Requires-Dist: pre-commit>=3.5.0; extra == 'dev'
Requires-Dist: pymdown-extensions>=10.11.2; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest>=8.3; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Description-Content-Type: text/markdown

AgentsFlow
==========

[![Docs](https://img.shields.io/badge/docs-latest-0a7ea4?logo=readthedocs&logoColor=white)](https://docs.agentsflow.dev)

Temporal workflows and activities for the automation stack. This README is intentionally thin—full operator and contributor docs live at [docs.agentsflow.dev](https://docs.agentsflow.dev). New operators can jump straight to the Quickstart/Deployment guides on the docs site.

Quick start (MCP)
-----------------
The easiest way to run AgentsFlow is as an MCP server using `uvx` (part of [uv](https://github.com/astral-sh/uv)).

Prerequisites
-------------
- `uvx` (install [uv](https://github.com/astral-sh/uv#installation) to get the `uvx` runner)
- Temporal CLI/dev server (for the local Web UI at http://localhost:8233): https://docs.temporal.io/cli

### Option 1: Use with AI Assistant (Recommended)
Run the following commands to add AgentsFlow as an MCP server.

**Claude Code**
```bash
claude mcp add agentsflow --scope user --env OPENAI_API_KEY=sk-... -- uvx agentsflow
```

**Gemini CLI**
```bash
gemini mcp add agentsflow --scope user --env OPENAI_API_KEY=sk-... -- uvx agentsflow
```

**Codex CLI**
```bash
codex mcp add agentsflow --env OPENAI_API_KEY=sk-... -- uvx agentsflow
```

**Cursor** (`.cursor/mcp.json` or via Settings > MCP)
```json
{
  "mcpServers": {
    "agentsflow": {
      "command": "uvx",
      "args": ["agentsflow"],
      "env": {
        "OPENAI_API_KEY": "sk-..."
      }
    }
  }
}
```

### Option 2: Standalone HTTP Server
To run the stack independently (e.g. for debugging or remote access):
```bash
uvx agentsflow --transport streamable-http
```

### Tracking Progress
Regardless of how you run it (Option 1 or 2), you can track workflow execution and status in the Temporal Web UI at http://localhost:8233.

### 3. Use it
Once connected, you can use natural language to trigger workflows:
- "Create a feature branch for issue JIRA-123"
- "Start the process workflow for the current repository"

Architecture (high level)
-------------------------
```mermaid
flowchart LR
  Dev[CLI / MCP client] -->|start process workflow| Temporal[Temporal Server]
  Temporal --> Worker[AgentsFlow worker]
  Worker --> Activities[Git / Issue / ACP activities]
  Activities --> Repo[(Git worktree)]
  Activities --> Providers[Jira or GitHub issues]
  Activities --> ACP[Claude / Gemini / Codex ACP]
```

Supported issue providers
-------------------------
| Provider | Credentials | Notes |
| --- | --- | --- |
| Jira | `JIRA_EMAIL` + `JIRA_API_TOKEN` (optional `JIRA_HOST_ALLOWLIST`, `JIRA_TIMEOUT_SECONDS`) | Hosts matching `atlassian.net`/`jira` or allowlisted domains route here. |
| GitHub | `GITHUB_TOKEN` (optional `GITHUB_TIMEOUT_SECONDS`) | Uses the GitHub Issues API for `github.com/<org>/<repo>/issues/<id>` URLs. |

Docs
----
- New operators: Quickstart + deployment: https://docs.agentsflow.dev
- Process workflow: https://docs.agentsflow.dev/workflows/process
- Providers + env reference: https://docs.agentsflow.dev/guides/providers
