acp-sdk 0.7.1__tar.gz → 0.7.3__tar.gz

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acp-sdk
-Version: 0.7.1
+Version: 0.7.3
 Summary: Agent Communication Protocol SDK
 Author: IBM Corp.
 Maintainer-email: Tomas Pilar <thomas7pilar@gmail.com>

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/docs/client.md

@@ -71,15 +71,15 @@ async with Client(base_url="http://localhost:8000") as client:
   message = Message(parts=[MessagePart(content="Hello")])
 
   # Async
-  run = await client.run_async(agent_name="agent", input=[message])
+  run = await client.run_async(agent="agent", input=[message])
   print(run.status)
 
   # Sync - waits for completion, failure, cancellation or await
-  run = await client.run_sync(agent_name="agent", input=[message])
+  run = await client.run_sync(agent="agent", input=[message])
   print(run.output)
   
   # Stream - as sync but also receives events
-  async for event in client.run_stream(agent_name="agent", input=[message])
+  async for event in client.run_stream(agent="agent", input=[message])
     print(event)
 ```
 
@@ -95,5 +95,5 @@ async with Client(base_url="http://localhost:8000" as client:
 
     async with client.session() as session:
         for agent in agents:
-            await session.run_sync(agent_name=agent.name, input=[Message(parts=[MessagePart(content="Hello!")])])
+            await session.run_sync(agent=agent.name, input=[Message(parts=[MessagePart(content="Hello!")])])
 ```

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "acp-sdk"
-version = "0.7.1"
+version = "0.7.3"
 description = "Agent Communication Protocol SDK"
 license = "Apache-2.0"
 readme = "README.md"

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/src/acp_sdk/client/client.py

@@ -25,7 +25,6 @@ from acp_sdk.models import (
     Event,
     Run,
     RunCancelResponse,
-    RunCreatedEvent,
     RunCreateRequest,
     RunCreateResponse,
     RunId,
@@ -120,6 +119,11 @@ class Client:
         response = AgentReadResponse.model_validate(response.json())
         return Agent(**response.model_dump())
 
+    async def ping(self) -> bool:
+        response = await self._client.get("/healthcheck")
+        self._raise_error(response)
+        return response.json() == "OK"
+
     async def run_sync(self, input: Input, *, agent: AgentName) -> Run:
         response = await self._client.post(
             "/runs",
@@ -132,7 +136,6 @@ class Client:
         )
         self._raise_error(response)
         response = RunCreateResponse.model_validate(response.json())
-        self._set_session(response)
         return Run(**response.model_dump())
 
     async def run_async(self, input: Input, *, agent: AgentName) -> Run:
@@ -147,7 +150,6 @@ class Client:
         )
         self._raise_error(response)
         response = RunCreateResponse.model_validate(response.json())
-        self._set_session(response)
         return Run(**response.model_dump())
 
     async def run_stream(self, input: Input, *, agent: AgentName) -> AsyncIterator[Event]:
@@ -163,8 +165,6 @@ class Client:
             ).model_dump_json(),
         ) as event_source:
             async for event in self._validate_stream(event_source):
-                if isinstance(event, RunCreatedEvent):
-                    self._set_session(event.run)
                 yield event
 
     async def run_status(self, *, run_id: RunId) -> Run:
@@ -222,6 +222,3 @@ class Client:
             response.raise_for_status()
         except httpx.HTTPError:
             raise ACPError(Error.model_validate(response.json()))
-
-    def _set_session(self, run: Run) -> None:
-        self._session_id = run.session_id

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/src/acp_sdk/models/models.py

@@ -47,6 +47,11 @@ class Dependency(BaseModel):
     name: str
 
 
+class Capability(BaseModel):
+    name: str
+    description: str
+
+
 class Metadata(BaseModel):
     annotations: AnyModel | None = None
     documentation: str | None = None
@@ -54,7 +59,8 @@ class Metadata(BaseModel):
     programming_language: str | None = None
     natural_languages: list[str] | None = None
     framework: str | None = None
-    use_cases: list[str] | None = None
+    capabilities: list[Capability] | None = None
+    domains: list[str] | None = None
     tags: list[str] | None = None
     created_at: datetime | None = None
     updated_at: datetime | None = None
@@ -93,7 +99,7 @@ class Message(BaseModel):
     def __add__(self, other: "Message") -> "Message":
         if not isinstance(other, Message):
             raise TypeError(f"Cannot concatenate Message with {type(other).__name__}")
-        return Message(*(self.parts + other.parts))
+        return Message(parts=self.parts + other.parts)
 
     def __str__(self) -> str:
         return "".join(

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/src/acp_sdk/server/app.py

@@ -5,7 +5,7 @@ from datetime import datetime, timedelta
 from enum import Enum
 
 from cachetools import TTLCache
-from fastapi import FastAPI, HTTPException, status
+from fastapi import Depends, FastAPI, HTTPException, status
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import JSONResponse, StreamingResponse
 from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
@@ -47,7 +47,12 @@ class Headers(str, Enum):
     RUN_ID = "Run-ID"
 
 
-def create_app(*agents: Agent, run_limit: int = 1000, run_ttl: timedelta = timedelta(hours=1)) -> FastAPI:
+def create_app(
+    *agents: Agent,
+    run_limit: int = 1000,
+    run_ttl: timedelta = timedelta(hours=1),
+    dependencies: list[Depends] | None = None,
+) -> FastAPI:
     executor: ThreadPoolExecutor
 
     @asynccontextmanager
@@ -57,7 +62,10 @@ def create_app(*agents: Agent, run_limit: int = 1000, run_ttl: timedelta = timed
             executor = exec
             yield
 
-    app = FastAPI(lifespan=lifespan)
+    app = FastAPI(
+        lifespan=lifespan,
+        dependencies=dependencies,
+    )
 
     FastAPIInstrumentor.instrument_app(app)
 
@@ -96,11 +104,15 @@ def create_app(*agents: Agent, run_limit: int = 1000, run_ttl: timedelta = timed
         agent = find_agent(name)
         return AgentModel(name=agent.name, description=agent.description, metadata=agent.metadata)
 
+    @app.get("/healthcheck")
+    async def healthcheck() -> str:
+        return "OK"
+
     @app.post("/runs")
     async def create_run(request: RunCreateRequest) -> RunCreateResponse:
         agent = find_agent(request.agent_name)
 
-        session = sessions.get(request.session_id, Session()) if request.session_id else Session()
+        session = sessions.get(request.session_id, Session(id=request.session_id)) if request.session_id else Session()
         nonlocal executor
         bundle = RunBundle(
             agent=agent,

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/src/acp_sdk/server/server.py

@@ -4,6 +4,7 @@ from collections.abc import Awaitable
 from datetime import timedelta
 from typing import Any, Callable
 
+import requests
 import uvicorn
 import uvicorn.config
 
@@ -12,7 +13,9 @@ from acp_sdk.server.agent import Agent
 from acp_sdk.server.agent import agent as agent_decorator
 from acp_sdk.server.app import create_app
 from acp_sdk.server.logging import configure_logger as configure_logger_func
+from acp_sdk.server.logging import logger
 from acp_sdk.server.telemetry import configure_telemetry as configure_telemetry_func
+from acp_sdk.server.utils import async_request_with_retry
 
 
 class Server:
@@ -43,6 +46,7 @@ class Server:
         self,
         configure_logger: bool = True,
         configure_telemetry: bool = False,
+        self_registration: bool = True,
         run_limit: int = 1000,
         run_ttl: timedelta = timedelta(hours=1),
         host: str = "127.0.0.1",
@@ -158,7 +162,14 @@ class Server:
             h11_max_incomplete_event_size,
         )
         self._server = uvicorn.Server(config)
-        self._server.run()
+
+        asyncio.run(self._serve(self_registration=self_registration))
+
+    async def _serve(self, self_registration: bool = True) -> None:
+        registration_task = asyncio.create_task(self._register_agent()) if self_registration else None
+        await self._server.serve()
+        if registration_task:
+            registration_task.cancel()
 
     @property
     def should_exit(self) -> bool:
@@ -167,3 +178,45 @@ class Server:
     @should_exit.setter
     def should_exit(self, value: bool) -> None:
         self._server.should_exit = value
+
+    async def _register_agent(self) -> None:
+        """If not in PRODUCTION mode, register agent to the beeai platform and provide missing env variables"""
+        if os.getenv("PRODUCTION_MODE", False):
+            logger.debug("Agent is not automatically registered in the production mode.")
+            return
+
+        url = os.getenv("PLATFORM_URL", "http://127.0.0.1:8333")
+        for agent in self._agents:
+            request_data = {
+                "location": f"http://{self._server.config.host}:{self._server.config.port}",
+                "id": agent.name,
+            }
+            try:
+                await async_request_with_retry(
+                    lambda client, data=request_data: client.post(
+                        f"{url}/api/v1/provider/register/unmanaged", json=data
+                    )
+                )
+                logger.info("Agent registered to the beeai server.")
+
+                # check missing env keyes
+                envs_request = await async_request_with_retry(lambda client: client.get(f"{url}/api/v1/env"))
+                envs = envs_request.get("env")
+
+                # register all available envs
+                missing_keyes = []
+                for env in agent.metadata.model_dump().get("env", []):
+                    server_env = envs.get(env.get("name"))
+                    if server_env:
+                        logger.debug(f"Env variable {env['name']} = '{server_env}' added dynamically")
+                        os.environ[env["name"]] = server_env
+                    elif env.get("required"):
+                        missing_keyes.append(env)
+                if len(missing_keyes):
+                    logger.error(f"Can not run agent, missing required env variables: {missing_keyes}")
+                    raise Exception("Missing env variables")
+
+            except requests.exceptions.ConnectionError as e:
+                logger.warning(f"Can not reach server, check if running on {url} : {e}")
+            except (requests.exceptions.HTTPError, Exception) as e:
+                logger.warning(f"Agent can not be registered to beeai server: {e}")

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/src/acp_sdk/server/session.py

@@ -7,8 +7,8 @@ from acp_sdk.server.bundle import RunBundle
 
 
 class Session:
-    def __init__(self) -> None:
-        self.id: SessionId = uuid.uuid4()
+    def __init__(self, id: SessionId | None = None) -> None:
+        self.id: SessionId = id or uuid.uuid4()
         self.bundles: list[RunBundle] = []
 
     def append(self, bundle: RunBundle) -> None:

acp_sdk-0.7.3/src/acp_sdk/server/utils.py

@@ -0,0 +1,49 @@
+import asyncio
+from collections.abc import AsyncGenerator, Coroutine
+from typing import Any, Callable
+
+import httpx
+import requests
+from pydantic import BaseModel
+
+from acp_sdk.server.bundle import RunBundle
+from acp_sdk.server.logging import logger
+
+
+def encode_sse(model: BaseModel) -> str:
+    return f"data: {model.model_dump_json()}\n\n"
+
+
+async def stream_sse(bundle: RunBundle) -> AsyncGenerator[str]:
+    async for event in bundle.stream():
+        yield encode_sse(event)
+
+
+async def async_request_with_retry(
+    request_func: Callable[[httpx.AsyncClient], Coroutine[Any, Any, httpx.Response]],
+    max_retries: int = 5,
+    backoff_factor: float = 1,
+) -> dict[str, Any]:
+    async with httpx.AsyncClient() as client:
+        retries = 0
+        while retries < max_retries:
+            try:
+                response = await request_func(client)
+                response.raise_for_status()
+                return response.json()
+            except httpx.HTTPStatusError as e:
+                if e.response.status_code in [429, 500, 502, 503, 504, 509]:
+                    retries += 1
+                    backoff = backoff_factor * (2 ** (retries - 1))
+                    logger.warning(f"Request retry (try {retries}/{max_retries}), waiting {backoff} seconds...")
+                    await asyncio.sleep(backoff)
+                else:
+                    logger.debug("A non-retryable error was encountered.")
+                    raise
+            except httpx.RequestError:
+                retries += 1
+                backoff = backoff_factor * (2 ** (retries - 1))
+                logger.warning(f"Request retry (try {retries}/{max_retries}), waiting {backoff} seconds...")
+                await asyncio.sleep(backoff)
+
+        raise requests.exceptions.ConnectionError(f"Request failed after {max_retries} retries.")

acp_sdk-0.7.3/tests/unit/client/test_client.py

@@ -0,0 +1,159 @@
+import json
+import uuid
+
+import pytest
+from acp_sdk.client import Client
+from acp_sdk.models import Agent, AgentsListResponse, Message, MessagePart, Run, RunCompletedEvent
+from acp_sdk.models.models import MessageAwaitResume
+from pytest_httpx import HTTPXMock
+
+mock_agent = Agent(name="mock")
+mock_agents = [mock_agent]
+mock_run = Run(
+    agent_name=mock_agent.name, session_id=uuid.uuid4(), output=[Message(parts=[MessagePart(content="Hello!")])]
+)
+
+
+@pytest.mark.asyncio
+async def test_agents(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(
+        url="http://test/agents", method="GET", content=AgentsListResponse(agents=mock_agents).model_dump_json()
+    )
+
+    async with Client(base_url="http://test") as client:
+        agents = [agent async for agent in client.agents()]
+        assert agents == mock_agents
+
+
+@pytest.mark.asyncio
+async def test_agent(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(
+        url=f"http://test/agents/{mock_agent.name}", method="GET", content=mock_agent.model_dump_json()
+    )
+
+    async with Client(base_url="http://test") as client:
+        agent = await client.agent(name=mock_agent.name)
+        assert agent == mock_agent
+
+
+@pytest.mark.asyncio
+async def test_run_sync(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(url="http://test/runs", method="POST", content=mock_run.model_dump_json())
+
+    async with Client(base_url="http://test") as client:
+        run = await client.run_sync("Howdy!", agent=mock_run.agent_name)
+        assert run == mock_run
+
+
+@pytest.mark.asyncio
+async def test_run_async(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(url="http://test/runs", method="POST", content=mock_run.model_dump_json())
+
+    async with Client(base_url="http://test") as client:
+        run = await client.run_async("Howdy!", agent=mock_run.agent_name)
+        assert run == mock_run
+
+
+@pytest.mark.asyncio
+async def test_run_stream(httpx_mock: HTTPXMock) -> None:
+    mock_event = RunCompletedEvent(run=mock_run)
+    httpx_mock.add_response(
+        url="http://test/runs",
+        method="POST",
+        headers={"content-type": "text/event-stream"},
+        content=f"data: {mock_event.model_dump_json()}\n\n",
+    )
+
+    async with Client(base_url="http://test") as client:
+        async for event in client.run_stream("Howdy!", agent=mock_run.agent_name):
+            assert event == mock_event
+
+
+@pytest.mark.asyncio
+async def test_run_status(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(url=f"http://test/runs/{mock_run.run_id}", method="GET", content=mock_run.model_dump_json())
+
+    async with Client(base_url="http://test") as client:
+        run = await client.run_status(run_id=mock_run.run_id)
+        assert run == mock_run
+
+
+@pytest.mark.asyncio
+async def test_run_cancel(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(
+        url=f"http://test/runs/{mock_run.run_id}/cancel", method="POST", content=mock_run.model_dump_json()
+    )
+
+    async with Client(base_url="http://test") as client:
+        run = await client.run_cancel(run_id=mock_run.run_id)
+        assert run == mock_run
+
+
+@pytest.mark.asyncio
+async def test_run_resume_sync(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(
+        url=f"http://test/runs/{mock_run.run_id}", method="POST", content=mock_run.model_dump_json()
+    )
+
+    async with Client(base_url="http://test") as client:
+        run = await client.run_resume_sync(MessageAwaitResume(message=Message(parts=[])), run_id=mock_run.run_id)
+        assert run == mock_run
+
+
+@pytest.mark.asyncio
+async def test_run_resume_async(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(
+        url=f"http://test/runs/{mock_run.run_id}", method="POST", content=mock_run.model_dump_json()
+    )
+
+    async with Client(base_url="http://test") as client:
+        run = await client.run_resume_async(MessageAwaitResume(message=Message(parts=[])), run_id=mock_run.run_id)
+        assert run == mock_run
+
+
+@pytest.mark.asyncio
+async def test_run_resume_stream(httpx_mock: HTTPXMock) -> None:
+    mock_event = RunCompletedEvent(run=mock_run)
+    httpx_mock.add_response(
+        url=f"http://test/runs/{mock_run.run_id}",
+        method="POST",
+        headers={"content-type": "text/event-stream"},
+        content=f"data: {mock_event.model_dump_json()}\n\n",
+    )
+
+    async with Client(base_url="http://test") as client:
+        async for event in client.run_resume_stream(
+            MessageAwaitResume(message=Message(parts=[])), run_id=mock_run.run_id
+        ):
+            assert event == mock_event
+
+
+@pytest.mark.asyncio
+async def test_session(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(url="http://test/runs", method="POST", content=mock_run.model_dump_json(), is_reusable=True)
+
+    async with Client(base_url="http://test") as client, client.session(mock_run.session_id) as session:
+        assert session._session_id == mock_run.session_id
+        await session.run_sync("Howdy!", agent=mock_run.agent_name)
+        await client.run_sync("Howdy!", agent=mock_run.agent_name)
+
+    requests = httpx_mock.get_requests()
+    body = json.loads(requests[0].content)
+    assert body["session_id"] == str(mock_run.session_id)
+
+    body = json.loads(requests[1].content)
+    assert body["session_id"] is None
+
+
+@pytest.mark.asyncio
+async def test_no_session(httpx_mock: HTTPXMock) -> None:
+    httpx_mock.add_response(url="http://test/runs", method="POST", content=mock_run.model_dump_json(), is_reusable=True)
+
+    async with Client(base_url="http://test") as client:
+        await client.run_sync("Howdy!", agent=mock_run.agent_name)
+        await client.run_sync("Howdy!", agent=mock_run.agent_name)
+
+    requests = httpx_mock.get_requests()
+
+    body = json.loads(requests[1].content)
+    assert body["session_id"] is None

{acp_sdk-0.7.1 → acp_sdk-0.7.3}/tests/unit/models/test_models.py

@@ -2,6 +2,25 @@ import pytest
 from acp_sdk.models.models import Message, MessagePart
 
 
+@pytest.mark.parametrize(
+    "first,second,result",
+    [
+        (
+            Message(parts=[MessagePart(content_type="text/plain", content="Foo")]),
+            Message(parts=[MessagePart(content_type="text/plain", content="Bar")]),
+            Message(
+                parts=[
+                    MessagePart(content_type="text/plain", content="Foo"),
+                    MessagePart(content_type="text/plain", content="Bar"),
+                ]
+            ),
+        )
+    ],
+)
+def test_message_add(first: Message, second: Message, result: Message) -> None:
+    assert first + second == result
+
+
 @pytest.mark.parametrize(
     "uncompressed,compressed",
     [

acp_sdk-0.7.1/src/acp_sdk/server/utils.py

@@ -1,14 +0,0 @@
-from collections.abc import AsyncGenerator
-
-from pydantic import BaseModel
-
-from acp_sdk.server.bundle import RunBundle
-
-
-def encode_sse(model: BaseModel) -> str:
-    return f"data: {model.model_dump_json()}\n\n"
-
-
-async def stream_sse(bundle: RunBundle) -> AsyncGenerator[str]:
-    async for event in bundle.stream():
-        yield encode_sse(event)

acp_sdk-0.7.1/tests/unit/client/test_client.py

@@ -1,36 +0,0 @@
-import pytest
-from acp_sdk.client import Client
-from acp_sdk.models import Message, MessagePart, Run, RunCompletedEvent
-from pytest_httpx import HTTPXMock
-
-mock_run = Run(agent_name="mock", output=[Message(parts=[MessagePart(content="Hello!")])])
-
-
-@pytest.mark.asyncio
-async def test_run_sync(httpx_mock: HTTPXMock) -> None:
-    httpx_mock.add_response(content=mock_run.model_dump_json())
-
-    async with Client(base_url="http://localhost:8000") as client:
-        run = await client.run_sync("Howdy!", agent="mock")
-        assert run == mock_run
-
-
-@pytest.mark.asyncio
-async def test_run_async(httpx_mock: HTTPXMock) -> None:
-    httpx_mock.add_response(content=mock_run.model_dump_json())
-
-    async with Client(base_url="http://localhost:8000") as client:
-        run = await client.run_async("Howdy!", agent="mock")
-        assert run == mock_run
-
-
-@pytest.mark.asyncio
-async def test_run_stream(httpx_mock: HTTPXMock) -> None:
-    mock_event = RunCompletedEvent(run=mock_run)
-    httpx_mock.add_response(
-        headers={"content-type": "text/event-stream"}, content=f"data: {mock_event.model_dump_json()}\n\n"
-    )
-
-    async with Client(base_url="http://localhost:8000") as client:
-        async for event in client.run_stream("Howdy!", agent="mock"):
-            assert event == mock_event