acp-sdk 0.0.6__py3-none-any.whl → 0.1.0__py3-none-any.whl

acp_sdk/version.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("acp-sdk")

acp_sdk-0.1.0.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: acp-sdk
+Version: 0.1.0
+Summary: Agent Communication Protocol SDK
+Author: IBM Corp.
+Maintainer-email: Tomas Pilar <thomas7pilar@gmail.com>
+License-Expression: Apache-2.0
+Requires-Python: <4.0,>=3.11
+Requires-Dist: opentelemetry-api>=1.31.1
+Requires-Dist: pydantic>=2.11.1
+Provides-Extra: client
+Requires-Dist: httpx-sse>=0.4.0; extra == 'client'
+Requires-Dist: httpx>=0.28.1; extra == 'client'
+Requires-Dist: opentelemetry-instrumentation-httpx>=0.52b1; extra == 'client'
+Provides-Extra: server
+Requires-Dist: fastapi[standard]>=0.115.8; extra == 'server'
+Requires-Dist: janus>=2.0.0; extra == 'server'
+Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.31.1; extra == 'server'
+Requires-Dist: opentelemetry-instrumentation-fastapi>=0.52b1; extra == 'server'
+Requires-Dist: opentelemetry-sdk>=1.31.1; extra == 'server'
+Description-Content-Type: text/markdown
+
+# Agent Communication Protocol SDK for Python
+
+Agent Communication Protocol SDK for Python provides allows developers to serve and consume agents over the Agent Communication Protocol.
+
+## Prerequisites
+
+✅ Python >= 3.11
+
+## Installation
+
+Install to use client:
+
+```shell
+pip install acp-sdk[client]
+```
+
+Install to use server:
+
+```shell
+pip install acp-sdk[server]
+```
+
+Install to use models only:
+
+```shell
+pip install acp-sdk
+```
+
+## Overview
+
+### Core
+
+The core of the SDK exposes [pydantic](https://docs.pydantic.dev/) data models corresponding to REST API requests, responses, resources, events and errors.
+
+
+### Client
+
+The `client` submodule exposes [httpx](https://www.python-httpx.org/) based client with simple methods for communication over ACP.
+
+```python
+async with Client(base_url="http://localhost:8000") as client:
+    run = await client.run_sync(agent="echo", inputs=[Message(parts=[MessagePart(content="Howdy!")])])
+    print(run)
+
+```
+
+### Server
+
+The `server` submodule exposes `Agent` class and `agent` decorator together with [fastapi](https://fastapi.tiangolo.com/) application factory, making it easy to expose agents over ACP. Additionaly, it exposes [uvicorn](https://www.uvicorn.org/) based server to serve agents with set up logging, [opentelemetry](https://opentelemetry.io/) and more.
+
+```python
+server = Server()
+
+@server.agent()
+async def echo(inputs: list[Message], context: Context) -> AsyncGenerator[RunYield, RunYieldResume]:
+    """Echoes everything"""
+    for message in inputs:
+        yield {"thought": "I should echo everyting"}
+        await asyncio.sleep(0.5)
+        yield message
+
+
+server.run()
+```
+
+➡️ Explore more in our [examples library](/python/examples).
+
+## Architecture
+
+The architecture of the SDK is outlined in the following segment. It focuses on central parts of the SDK without going into much detail.
+
+### Models
+
+The core of the SDK contains pydantic models for requests, responses, resources, events and errors. Users of the SDK are meant to use these models directly or indirectly.
+
+### Server
+
+The server module consists of 3 parts:
+  
+  1. Agent interface
+  2. FastAPI application factory
+  3. Uvicorn based server
+
+Each part builds on top of the previous one. Not all parts need to be used, e.g. users are advised to bring their own ASGI server for production deployments.
+
+### Client
+
+The client module consists of httpx based client with session support. The client is meant to be thin and mimic the REST API. Exception is session management which has been abstracted into a context manager.
+
+
+  

acp_sdk-0.1.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+acp_sdk/__init__.py,sha256=tXdAUM9zcmdSKCAkVrOCrGcXcuVS-yuvQUoQwTe9pek,98
+acp_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+acp_sdk/version.py,sha256=Niy83rgvigB4hL_rR-O4ySvI7dj6xnqkyOe_JTymi9s,73
+acp_sdk/client/__init__.py,sha256=Bca1DORrswxzZsrR2aUFpATuNG2xNSmYvF1Z2WJaVbc,51
+acp_sdk/client/client.py,sha256=phsFdVMdVmTcfmzUQUgqzzvq4zNvmEUgW2eL9cFJY2g,6140
+acp_sdk/models/__init__.py,sha256=numSDBDT1QHx7n_Y3Deb5VOvKWcUBxbOEaMwQBSRHxc,151
+acp_sdk/models/errors.py,sha256=rEyaMVvQuBi7fwWe_d0PGGySYsD3FZTluQ-SkC0yhAs,444
+acp_sdk/models/models.py,sha256=kxCbWoukCYrUseJZF0xUOgGc-3cS32VBSXggHroZ-H0,4676
+acp_sdk/models/schemas.py,sha256=LNs3oN1pQ4GD0ceV3-k6X6R39eu33nsAfnW6uEgOP0c,735
+acp_sdk/server/__init__.py,sha256=mxBBBFaZuMEUENRMLwp1XZkuLeT9QghcFmNvjnqvAAU,377
+acp_sdk/server/agent.py,sha256=fGky5MIuknw-Gy-THqhWLt9I9-gUyNIar8qEAvZb3uQ,6195
+acp_sdk/server/app.py,sha256=Ys5EN4MzmrwrpBGvycEP5dKEIYkDZmeBMMV1Aq58AU0,5897
+acp_sdk/server/bundle.py,sha256=VUOqzBhwsADkoyPWqXSZ2KG59S3q4LMDfpFVAssnGSM,5386
+acp_sdk/server/context.py,sha256=MgnLV6qcDIhc_0BjW7r4Jj1tHts4ZuwpdTGIBnz2Mgo,1036
+acp_sdk/server/errors.py,sha256=fWlgVsQ5hs_AXwzc-wvy6QgoDWEMRUBlSrfJfhHHMyE,2085
+acp_sdk/server/logging.py,sha256=Oc8yZigCsuDnHHPsarRzu0RX3NKaLEgpELM2yovGKDI,411
+acp_sdk/server/server.py,sha256=-eT3fmnEsBUN44Spi2EP2eV0l4RAlKa8bzqxnhz16SM,5399
+acp_sdk/server/session.py,sha256=0cDr924HC5x2bBNbK9NSKVHAt5A_mi5dK8P4jP_ugq0,629
+acp_sdk/server/telemetry.py,sha256=WIEHK8syOTG9SyWi3Y-cos7CsCF5-IHGiyL9bCaUN0E,1921
+acp_sdk/server/types.py,sha256=2yJPkfUzjVIhHmc0SegGTMqDROe2uFgycb-7CATvYVw,161
+acp_sdk/server/utils.py,sha256=EfrF9VCyVk3AM_ao-BIB9EzGbfTrh4V2Bz-VFr6f6Sg,351
+acp_sdk-0.1.0.dist-info/METADATA,sha256=I2gNsDG4Zskh5oddVAYBttUiGIKExdIfFNA8Br6fioQ,3463
+acp_sdk-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+acp_sdk-0.1.0.dist-info/RECORD,,

acp/__init__.py

@@ -1,138 +0,0 @@
-from .client.session import ClientSession
-from .client.stdio import StdioServerParameters, stdio_client
-from .server.session import ServerSession
-from .server.stdio import stdio_server
-from .shared.exceptions import McpError
-from .types import (
-    Agent,
-    AgentTemplate,
-    CallToolRequest,
-    ClientCapabilities,
-    ClientNotification,
-    ClientRequest,
-    ClientResult,
-    CompleteRequest,
-    CreateAgentRequest,
-    CreateAgentResult,
-    CreateMessageRequest,
-    CreateMessageResult,
-    DestroyAgentRequest,
-    DestroyAgentResult,
-    ErrorData,
-    GetPromptRequest,
-    GetPromptResult,
-    Implementation,
-    IncludeContext,
-    InitializedNotification,
-    InitializeRequest,
-    InitializeResult,
-    JSONRPCError,
-    JSONRPCRequest,
-    JSONRPCResponse,
-    ListAgentsRequest,
-    ListAgentsResult,
-    ListAgentTemplatesRequest,
-    ListAgentTemplatesResult,
-    ListPromptsRequest,
-    ListPromptsResult,
-    ListResourcesRequest,
-    ListResourcesResult,
-    ListToolsResult,
-    LoggingLevel,
-    LoggingMessageNotification,
-    Notification,
-    PingRequest,
-    ProgressNotification,
-    PromptsCapability,
-    ReadResourceRequest,
-    ReadResourceResult,
-    Resource,
-    ResourcesCapability,
-    ResourceUpdatedNotification,
-    RootsCapability,
-    RunAgentRequest,
-    RunAgentResult,
-    SamplingMessage,
-    ServerCapabilities,
-    ServerNotification,
-    ServerRequest,
-    ServerResult,
-    SetLevelRequest,
-    StopReason,
-    SubscribeRequest,
-    Tool,
-    ToolsCapability,
-    UnsubscribeRequest,
-)
-from .types import (
-    Role as SamplingRole,
-)
-
-__all__ = [
-    "CallToolRequest",
-    "ClientCapabilities",
-    "ClientNotification",
-    "ClientRequest",
-    "ClientResult",
-    "ClientSession",
-    "CreateMessageRequest",
-    "CreateMessageResult",
-    "ErrorData",
-    "GetPromptRequest",
-    "GetPromptResult",
-    "Implementation",
-    "IncludeContext",
-    "InitializeRequest",
-    "InitializeResult",
-    "InitializedNotification",
-    "JSONRPCError",
-    "JSONRPCRequest",
-    "ListPromptsRequest",
-    "ListPromptsResult",
-    "ListResourcesRequest",
-    "ListResourcesResult",
-    "ListToolsResult",
-    "LoggingLevel",
-    "LoggingMessageNotification",
-    "McpError",
-    "Notification",
-    "PingRequest",
-    "ProgressNotification",
-    "PromptsCapability",
-    "ReadResourceRequest",
-    "ReadResourceResult",
-    "ResourcesCapability",
-    "ResourceUpdatedNotification",
-    "Resource",
-    "RootsCapability",
-    "SamplingMessage",
-    "SamplingRole",
-    "ServerCapabilities",
-    "ServerNotification",
-    "ServerRequest",
-    "ServerResult",
-    "ServerSession",
-    "SetLevelRequest",
-    "StdioServerParameters",
-    "StopReason",
-    "SubscribeRequest",
-    "Tool",
-    "ToolsCapability",
-    "UnsubscribeRequest",
-    "stdio_client",
-    "stdio_server",
-    "CompleteRequest",
-    "JSONRPCResponse",
-    "AgentTemplate",
-    "ListAgentTemplatesRequest",
-    "ListAgentTemplatesResult",
-    "Agent",
-    "ListAgentsRequest",
-    "ListAgentsResult",
-    "CreateAgentRequest",
-    "CreateAgentResult",
-    "DestroyAgentRequest",
-    "DestroyAgentResult",
-    "RunAgentRequest",
-    "RunAgentResult",
-]

acp/cli/__init__.py

@@ -1,6 +0,0 @@
-"""FastMCP CLI package."""
-
-from .cli import app
-
-if __name__ == "__main__":
-    app()

acp/cli/claude.py

@@ -1,139 +0,0 @@
-"""Claude app integration utilities."""
-
-import json
-import sys
-from pathlib import Path
-
-from acp.server.highlevel.utilities.logging import get_logger
-
-logger = get_logger(__name__)
-
-MCP_PACKAGE = "acp[cli]"
-
-
-def get_claude_config_path() -> Path | None:
-    """Get the Claude config directory based on platform."""
-    if sys.platform == "win32":
-        path = Path(Path.home(), "AppData", "Roaming", "Claude")
-    elif sys.platform == "darwin":
-        path = Path(Path.home(), "Library", "Application Support", "Claude")
-    else:
-        return None
-
-    if path.exists():
-        return path
-    return None
-
-
-def update_claude_config(
-    file_spec: str,
-    server_name: str,
-    *,
-    with_editable: Path | None = None,
-    with_packages: list[str] | None = None,
-    env_vars: dict[str, str] | None = None,
-) -> bool:
-    """Add or update a FastMCP server in Claude's configuration.
-
-    Args:
-        file_spec: Path to the server file, optionally with :object suffix
-        server_name: Name for the server in Claude's config
-        with_editable: Optional directory to install in editable mode
-        with_packages: Optional list of additional packages to install
-        env_vars: Optional dictionary of environment variables. These are merged with
-            any existing variables, with new values taking precedence.
-
-    Raises:
-        RuntimeError: If Claude Desktop's config directory is not found, indicating
-            Claude Desktop may not be installed or properly set up.
-    """
-    config_dir = get_claude_config_path()
-    if not config_dir:
-        raise RuntimeError(
-            "Claude Desktop config directory not found. Please ensure Claude Desktop"
-            " is installed and has been run at least once to initialize its config."
-        )
-
-    config_file = config_dir / "claude_desktop_config.json"
-    if not config_file.exists():
-        try:
-            config_file.write_text("{}")
-        except Exception as e:
-            logger.error(
-                "Failed to create Claude config file",
-                extra={
-                    "error": str(e),
-                    "config_file": str(config_file),
-                },
-            )
-            return False
-
-    try:
-        config = json.loads(config_file.read_text())
-        if "mcpServers" not in config:
-            config["mcpServers"] = {}
-
-        # Always preserve existing env vars and merge with new ones
-        if (
-            server_name in config["mcpServers"]
-            and "env" in config["mcpServers"][server_name]
-        ):
-            existing_env = config["mcpServers"][server_name]["env"]
-            if env_vars:
-                # New vars take precedence over existing ones
-                env_vars = {**existing_env, **env_vars}
-            else:
-                env_vars = existing_env
-
-        # Build uv run command
-        args = ["run"]
-
-        # Collect all packages in a set to deduplicate
-        packages = {MCP_PACKAGE}
-        if with_packages:
-            packages.update(pkg for pkg in with_packages if pkg)
-
-        # Add all packages with --with
-        for pkg in sorted(packages):
-            args.extend(["--with", pkg])
-
-        if with_editable:
-            args.extend(["--with-editable", str(with_editable)])
-
-        # Convert file path to absolute before adding to command
-        # Split off any :object suffix first
-        if ":" in file_spec:
-            file_path, server_object = file_spec.rsplit(":", 1)
-            file_spec = f"{Path(file_path).resolve()}:{server_object}"
-        else:
-            file_spec = str(Path(file_spec).resolve())
-
-        # Add fastmcp run command
-        args.extend(["acp", "run", file_spec])
-
-        server_config = {
-            "command": "uv",
-            "args": args,
-        }
-
-        # Add environment variables if specified
-        if env_vars:
-            server_config["env"] = env_vars
-
-        config["mcpServers"][server_name] = server_config
-
-        config_file.write_text(json.dumps(config, indent=2))
-        logger.info(
-            f"Added server '{server_name}' to Claude config",
-            extra={"config_file": str(config_file)},
-        )
-        return True
-    except Exception as e:
-        logger.error(
-            "Failed to update Claude config",
-            extra={
-                "error": str(e),
-                "config_file": str(config_file),
-            },
-        )
-        return False