LlamaIndex Agent Workflows over the ACP wire
Project description
workflows-acp
Run an agent powered by LlamaIndex Workflows over the ACP wire.
Installation
To install from registry:
# with pip
pip install workflows-acp
# with uv
uv add workflows-acp
# with uv - tool install
uv tool install workflows-acp
To install from source:
git clone https://github.com/AstraBert/workflows-acp
cd workflows-acp
uv tool install .
To verify the installation:
wfacp --help
Usage
To use the CLI and Python API, set your GOOGLE_API_KEY in the environment:
export GOOGLE_API_KEY="my-api-key"
To reduce logging noise from mcp-use's telemetry, run:
export MCP_USE_ANONYMIZED_TELEMETRY=false
CLI
To use the CLI agent, provide an agent_config.yaml file with the following fields:
mode('ask' or 'bypass'): Permission mode for the agent. Default isask.tools: List of tools (from the default set) available to the agent.model: The LLM model for the agent (Gemini models only). Default isgemini-3-flash-preview.agent_task: The task for which you need the agent's assistance.
See the example in agent_config.yaml.
If you wish to provide additional instructions to the agent (e.g. context on the current project, best practices, coding style rules...) you can add these instructions to an AGENTS.md file in the directory the agent is working in.
You can add or modify configuration options in your agent_config.yaml using the wfacp CLI:
# Add a tool
wfacp add-tool -t read_file
# Remove a tool
wfacp rm-tool -t read_file
# Add or modify the agent task
wfacp task -t "You should assist the user with python coding"
# Set or change the mode
wfacp mode -m bypass
# Set or change the model
wfacp model -m gemini-3-pro-preview
To use the agent with MCP servers, create a .mcp.json file with server definitions:
{
"mcpServers": {
"with-stdio": {
"command": "npx",
"args": [
"@mcp/server",
"start"
]
},
"with-http": {
"url": "https://example.com/mcp"
}
}
}
For servers using stdio, specify a command and optionally a list of args and an env for the MCP process. For servers using http, specify a url and optionally add headers for requests.
See a complete example in .mcp.json.
MCP configuration can also be managed via CLI:
# Add a stdio MCP server
wfacp add-mcp --name test --transport stdio --command 'npx @mcp/server arg1 arg2' --env "PORT=3000" --env "TELEMETRY=false"
# Add an HTTP MCP server
wfacp add-mcp --name search --transport http --url https://www.search.com/mcp --header "Authorization=Bearer $API_KEY" --header "X-Hello-World=Hello world!"
# Remove a server
wfacp rm-mcp --name search
To run the agent, use an ACP-compatible client such as toad or Zed editor.
With toad
# Install toad
curl -fsSL batrachian.ai/install | sh
# Run
toad acp "wfacp run"
A terminal interface will open, allowing you to interact with the agent.
With Zed
Add the following to your settings.json:
{
"agent_servers": {
"AgentWorkflow": {
"command": "wfacp",
"args": [
"run"
]
}
}
}
You can then interact with the agent directly in the IDE.
Available tools by default
The following tools are available by default and can be enabled in your agent_config.yaml:
describe_dir_content: Describes the contents of a directory, listing files and subfolders.read_file: Reads the contents of a file and returns it as a string.grep_file_content: Searches for a regex pattern in a file and returns all matches.glob_paths: Finds files in a directory matching a glob pattern.write_file: Writes content to a file, with an option to overwrite.edit_file: Edits a file by replacing occurrences of a string with another string.execute_command: Executes a shell command with arguments. Optionally waits for completion.bash_output: Retrieves the stdout and stderr output of a previously started background process by PID.write_memory: Writes a memory with content and relevance score to persistent storage.read_memory: Reads the most recent and relevant memory records from persistent storage.create_todos: Creates a TODO list with specified items and statuses.list_todos: Lists all TODO items and their statuses.update_todo: Updates the status of a TODO item.
Examples
Find more examples of the CLI usage in the examples folder.
Python API
Define your ACP agent by specifying tools, customizing the agent prompt, or selecting an LLM model:
import asyncio
from workflows_acp.acp_wrapper import start_agent
from workflows_acp.models import Tool
def add(x: int, y: int) -> int:
return x + y
async def query_database(query: str) -> str:
result = await db.query(query).fetchall()
return "\n".join(result)
add_tool = Tool(
name="add",
description="Add two integers together",
fn=add,
)
db_tool = Tool(
name="query_database",
description="Query a database with SQL syntax",
fn=query_database,
)
task = "You are an accountant who needs to help the user with their expenses (`expenses` table in the database), and you can do so by using the `query_database` tool and perform mathematical operations with the `add` tool"
model = "gemini-2.5-flash"
def main() -> None:
asyncio.run(start_agent(tools=[db_tool, add_tool], agent_task=task, llm_model=model, use_mcp=False))
Or load the agent from an agent_config.yaml file:
import asyncio
from workflows_acp.acp_wrapper import start_agent
def main() -> None:
asyncio.run(start_agent(from_config_file=True, use_mcp=False))
You can also configure MCP servers:
import asyncio
import os
from workflows_acp.acp_wrapper import start_agent
from workflows_acp.mcp_wrapper import McpServersConfig, HttpMcpServer, StdioMcpServer
stdio_server = StdioMcpServer(command="npx", args=["@test/mcp", "helloworld"], env=None)
http_server = HttpMcpServer(url="https://example.com/mcp", headers={"Authorization": "Bearer " + os.getenv("API_KEY", "")})
servers_config = McpServersConfig(mcpServers={
"with-stdio": stdio_server,
"with-http": http_server,
})
def main() -> None:
asyncio.run(start_agent(from_config_file=True, use_mcp=True, mcp_config=servers_config))
Or load from a .mcp.json file:
import asyncio
from workflows_acp.acp_wrapper import start_agent
def main() -> None:
# Automatically finds .mcp.json, loads, and validates the config
asyncio.run(start_agent(from_config_file=True, use_mcp=True))
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file workflows_acp-0.1.0a2.tar.gz.
File metadata
- Download URL: workflows_acp-0.1.0a2.tar.gz
- Upload date:
- Size: 21.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
af6b4f4a9597169e0e02d59bcf6db487ad32358a1d24951e2f989bd6e13bcb5f
|
|
| MD5 |
8d75cf82bfb343c5f1bac61d9154315f
|
|
| BLAKE2b-256 |
5bec5a8ac58dd812130a9c6f6f61f8276ab056fddcf1f3c7241a3f43f45f3b16
|
File details
Details for the file workflows_acp-0.1.0a2-py3-none-any.whl.
File metadata
- Download URL: workflows_acp-0.1.0a2-py3-none-any.whl
- Upload date:
- Size: 28.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2110ce3598522d70d28a898f0dce47d9a4c2748535ce02a5d2df2d8c8aec5b07
|
|
| MD5 |
51e4c1c50e870020965d44ddfb7444b9
|
|
| BLAKE2b-256 |
9df30105b25fe4ea3633bf27e8c7661e615ebce8fd2d7bf8cba7ab0f94cae2cb
|