acp-sdk 0.12.3__tar.gz → 1.0.0__tar.gz

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/PKG-INFO

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

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/pyproject.toml

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

acp_sdk-1.0.0/src/acp_sdk/models/common.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel, ConfigDict
+
+
+class AnyModel(BaseModel):
+    model_config = ConfigDict(extra="allow")

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/src/acp_sdk/models/errors.py

@@ -1,7 +1,10 @@
 from enum import Enum
+from typing import Optional
 
 from pydantic import BaseModel
 
+from acp_sdk.models.common import AnyModel
+
 
 class ErrorCode(str, Enum):
     SERVER_ERROR = "server_error"
@@ -10,8 +13,9 @@ class ErrorCode(str, Enum):
 
 
 class Error(BaseModel):
-    code: ErrorCode
+    code: ErrorCode | str  # Allow arbitrary string for backwards compatibility
     message: str
+    data: Optional[AnyModel] = None
 
 
 class ACPError(Exception):

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/src/acp_sdk/models/models.py

@@ -8,16 +8,13 @@ from typing import Any, Literal, Optional, Union
 from pydantic import AnyUrl, BaseModel, ConfigDict, Field
 from pydantic.json_schema import SkipJsonSchema
 
+from acp_sdk.models.common import AnyModel
 from acp_sdk.models.errors import ACPError, Error
 from acp_sdk.models.platform import PlatformUIAnnotation
 from acp_sdk.models.types import AgentName, ResourceUrl, RunId, SessionId
 from acp_sdk.shared import ResourceLoader, ResourceStore
 
 
-class AnyModel(BaseModel):
-    model_config = ConfigDict(extra="allow")
-
-
 class Author(BaseModel):
     name: str
     email: str | None = None
@@ -111,11 +108,38 @@ class CitationMetadata(BaseModel):
     """
 
     kind: Literal["citation"] = "citation"
-    start_index: Optional[int]
-    end_index: Optional[int]
-    url: Optional[str]
-    title: Optional[str]
-    description: Optional[str]
+    start_index: Optional[int] = None
+    end_index: Optional[int] = None
+    url: Optional[str] = None
+    title: Optional[str] = None
+    description: Optional[str] = None
+
+
+class TrajectoryMetadata(BaseModel):
+    """
+    Represents trajectory information for an agent's reasoning or tool execution
+    steps. This metadata helps track the agent's decision-making process and
+    provides transparency into how the agent arrived at its response.
+
+    TrajectoryMetadata can capture either:
+    1. A reasoning step with a message
+    2. A tool execution with tool name, input, and output
+
+    This information can be used for debugging, audit trails, and providing
+    users with insight into the agent's thought process.
+
+    Properties:
+    - message: A reasoning step or thought in the agent's decision process.
+    - tool_name: Name of the tool that was executed.
+    - tool_input: Input parameters passed to the tool.
+    - tool_output: Output or result returned by the tool.
+    """
+
+    kind: Literal["trajectory"] = "trajectory"
+    message: Optional[str] = None
+    tool_name: Optional[str] = None
+    tool_input: Optional[AnyModel] = None
+    tool_output: Optional[AnyModel] = None
 
 
 class MessagePart(BaseModel):
@@ -127,7 +151,7 @@ class MessagePart(BaseModel):
 
     model_config = ConfigDict(extra="allow")
 
-    metadata: Optional[CitationMetadata] = Field(discriminator="kind", default=None)
+    metadata: Optional[CitationMetadata | TrajectoryMetadata] = Field(discriminator="kind", default=None)
 
     def model_post_init(self, __context: Any) -> None:
         if self.content is not None and self.content_url is not None:
@@ -326,10 +350,20 @@ Event = Union[
 ]
 
 
+class InputContentTypes(BaseModel):
+    types: list[str]
+
+
+class OutputContentTypes(BaseModel):
+    types: list[str]
+
+
 class AgentManifest(BaseModel):
     name: str
     description: str | None = None
     metadata: Metadata = Metadata()
+    input_content_types: list[str] = Field(default_factory=lambda: ["*/*"])
+    output_content_types: list[str] = Field(default_factory=lambda: ["*/*"])
 
 
 class Session(BaseModel):

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/src/acp_sdk/server/agent.py

@@ -17,6 +17,14 @@ class AgentManifest(abc.ABC):
     def description(self) -> str:
         return ""
 
+    @property
+    def input_content_types(self) -> list[str]:
+        return []
+
+    @property
+    def output_content_types(self) -> list[str]:
+        return []
+
     @property
     def metadata(self) -> Metadata:
         return Metadata()
@@ -38,6 +46,8 @@ def agent(
     description: str | None = None,
     *,
     metadata: Metadata | None = None,
+    input_content_types: list[str] | None = None,
+    output_content_types: list[str] | None = None,
 ) -> Callable[[Callable], AgentManifest]:
     """Decorator to create an agent."""
 
@@ -67,6 +77,14 @@ def agent(
             def metadata(self) -> Metadata:
                 return metadata or Metadata()
 
+            @property
+            def input_content_types(self) -> list[str]:
+                return input_content_types or ["*/*"]
+
+            @property
+            def output_content_types(self) -> list[str]:
+                return output_content_types or ["*/*"]
+
         agent: AgentManifest
         if inspect.isasyncgenfunction(fn):
 

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/src/acp_sdk/server/app.py

@@ -13,6 +13,7 @@ from fastapi.encoders import jsonable_encoder
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import JSONResponse, StreamingResponse
 from obstore.exceptions import NotFoundError
+from pydantic import AnyHttpUrl, ValidationError
 
 from acp_sdk.models import (
     ACPError,
@@ -67,6 +68,7 @@ def create_app(
     resource_store: ResourceStore | None = None,
     resource_loader: ResourceLoader | None = None,
     forward_resources: bool = True,
+    forward_base_url: AnyHttpUrl | str | None = None,
     lifespan: Lifespan[AppType] | None = None,
     dependencies: list[Depends] | None = None,
 ) -> FastAPI:
@@ -76,6 +78,12 @@ def create_app(
     ):
         raise ValueError("Resource forwarding must be enabled when resource store does not support HTTP URLs")
 
+    if isinstance(forward_base_url, str):
+        try:
+            forward_base_url = AnyHttpUrl(forward_base_url)
+        except ValidationError:
+            raise ValueError("forward_base_url must be a valid http(s) url")
+
     executor: ThreadPoolExecutor
     client = httpx.AsyncClient()
 
@@ -141,7 +149,13 @@ def create_app(
     async def list_agents() -> AgentsListResponse:
         return AgentsListResponse(
             agents=[
-                AgentModel(name=agent.name, description=agent.description, metadata=agent.metadata)
+                AgentModel(
+                    name=agent.name,
+                    description=agent.description,
+                    metadata=agent.metadata,
+                    input_content_types=agent.input_content_types,
+                    output_content_types=agent.output_content_types,
+                )
                 for agent in agents.values()
             ]
         )
@@ -149,7 +163,13 @@ def create_app(
     @app.get("/agents/{name}")
     async def read_agent(name: AgentName) -> AgentReadResponse:
         agent = find_agent(name)
-        return AgentModel(name=agent.name, description=agent.description, metadata=agent.metadata)
+        return AgentModel(
+            name=agent.name,
+            description=agent.description,
+            metadata=agent.metadata,
+            input_content_types=agent.input_content_types,
+            output_content_types=agent.output_content_types,
+        )
 
     @app.get("/ping")
     async def ping() -> PingResponse:
@@ -165,6 +185,10 @@ def create_app(
         def create_resource_url_forwarded(id: ResourceId) -> ResourceUrl:
             if not forward_resources:
                 raise RuntimeError("Resource forwarding disabled")
+            if forward_base_url:
+                return ResourceUrl(
+                    url=str(app.url_path_for("get_resource", resource_id=id).make_absolute_url(str(forward_base_url)))
+                )
             return ResourceUrl(url=str(req.url_for("get_resource", resource_id=id)))
 
         async def create_resource_url(id: ResourceId) -> ResourceUrl:

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/src/acp_sdk/server/server.py

@@ -9,6 +9,7 @@ import requests
 import uvicorn
 import uvicorn.config
 from fastapi import FastAPI
+from pydantic import AnyHttpUrl
 
 from acp_sdk.models import Metadata
 from acp_sdk.server.agent import AgentManifest
@@ -31,13 +32,21 @@ class Server:
         self,
         name: str | None = None,
         description: str | None = None,
+        input_content_types: list[str] | None = None,
+        output_content_types: list[str] | None = None,
         *,
         metadata: Metadata | None = None,
     ) -> Callable:
         """Decorator to register an agent."""
 
         def decorator(fn: Callable) -> Callable:
-            agent = agent_decorator(name=name, description=description, metadata=metadata)(fn)
+            agent = agent_decorator(
+                name=name,
+                description=description,
+                metadata=metadata,
+                input_content_types=input_content_types,
+                output_content_types=output_content_types,
+            )(fn)
             self.register(agent)
             return fn
 
@@ -59,6 +68,8 @@ class Server:
         store: Store | None = None,
         resource_store: ResourceStore | None = None,
         resource_loader: ResourceLoader | None = None,
+        forward_resources: bool = True,
+        forward_base_url: AnyHttpUrl | str | None = None,
         host: str = "127.0.0.1",
         port: int = 8000,
         uds: str | None = None,
@@ -127,6 +138,8 @@ class Server:
             store=store,
             resource_loader=resource_loader,
             resource_store=resource_store,
+            forward_resources=forward_resources,
+            forward_base_url=forward_base_url,
         )
 
         if configure_logger:
@@ -196,6 +209,8 @@ class Server:
         store: Store | None = None,
         resource_store: ResourceStore | None = None,
         resource_loader: ResourceLoader | None = None,
+        forward_resources: bool = True,
+        forward_base_url: AnyHttpUrl | str | None = None,
         host: str = "127.0.0.1",
         port: int = 8000,
         uds: str | None = None,
@@ -256,6 +271,8 @@ class Server:
                 store=store,
                 resource_store=resource_store,
                 resource_loader=resource_loader,
+                forward_resources=forward_resources,
+                forward_base_url=forward_base_url,
                 host=host,
                 port=port,
                 uds=uds,
@@ -331,14 +348,14 @@ class Server:
         request_data = {
             "location": f"http://{host}:{self.server.config.port}",
         }
-        await async_request_with_retry(lambda client, data=request_data: client.get(f"{url}/api/v1/providers"))
         try:
+            await async_request_with_retry(lambda client, data=request_data: client.get(f"{url}/api/v1/providers"))
             await async_request_with_retry(
                 lambda client, data=request_data: client.post(
                     f"{url}/api/v1/providers", json=data, params={"auto_remove": True}
                 )
             )
-            logger.info("Agent registered to the beeai server.")
+            logger.debug("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/variables"))
@@ -361,17 +378,17 @@ class Server:
                     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}")
+                    logger.debug(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}")
+            logger.debug(f"Can not reach server, check if running on {url} : {e}")
         except (requests.exceptions.HTTPError, Exception) as e:
             try:
                 error_message = e.response.json().get("detail")
                 if error_message:
-                    logger.warning(f"Agent can not be registered to beeai server: {error_message}")
+                    logger.debug(f"Agent can not be registered to beeai server: {error_message}")
                 else:
-                    logger.warning(f"Agent can not be registered to beeai server: {e}")
+                    logger.debug(f"Agent can not be registered to beeai server: {e}")
             except Exception:
-                logger.warning(f"Agent can not be registered to beeai server: {e}")
+                logger.debug(f"Agent can not be registered to beeai server: {e}")

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/tests/e2e/fixtures/server.py

@@ -112,7 +112,10 @@ def server(request: pytest.FixtureRequest, store: Store) -> Generator[None]:
 
         yield MessagePart(content=str(context.session.id), content_type="text/plain")
 
-    @server.agent()
+    @server.agent(
+        input_content_types=["text/plain", "application/json"],
+        output_content_types=["text/html", "application/json", "application/javascript", "text/css"],
+    )
     async def mime_types(input: list[Message], context: Context) -> AsyncIterator[Message]:
         yield MessagePart(content="<h1>HTML Content</h1>", content_type="text/html")
         yield MessagePart(content='{"key": "value"}', content_type="application/json")

acp_sdk-1.0.0/tests/e2e/test_suites/test_discovery.py

@@ -0,0 +1,42 @@
+import pytest
+from acp_sdk.client import Client
+from acp_sdk.models import AgentManifest
+from acp_sdk.server import Server
+
+
+@pytest.mark.asyncio
+async def test_ping(server: Server, client: Client) -> None:
+    await client.ping()
+    assert True
+
+
+@pytest.mark.asyncio
+async def test_agents_list(server: Server, client: Client) -> None:
+    async for agent in client.agents():
+        assert isinstance(agent, AgentManifest)
+
+
+@pytest.mark.asyncio
+async def test_agents_manifest(server: Server, client: Client) -> None:
+    agent_name = "echo"
+    agent = await client.agent(name=agent_name)
+    assert isinstance(agent, AgentManifest)
+    assert agent.name == agent_name
+
+
+@pytest.mark.asyncio
+async def test_input_content_types(server: Server, client: Client) -> None:
+    agent_name = "mime_types"
+    agent = await client.agent(name=agent_name)
+    assert isinstance(agent, AgentManifest)
+    assert agent.name == agent_name
+    assert agent.input_content_types == ["text/plain", "application/json"]
+
+
+@pytest.mark.asyncio
+async def test_output_content_types(server: Server, client: Client) -> None:
+    agent_name = "mime_types"
+    agent = await client.agent(name=agent_name)
+    assert isinstance(agent, AgentManifest)
+    assert agent.name == agent_name
+    assert agent.output_content_types == ["text/html", "application/json", "application/javascript", "text/css"]

{acp_sdk-0.12.3 → acp_sdk-1.0.0}/tests/unit/client/test_client.py

@@ -19,7 +19,7 @@ from acp_sdk.models import (
 )
 from pytest_httpx import HTTPXMock
 
-mock_agent = AgentManifest(name="mock")
+mock_agent = AgentManifest(name="mock", input_content_types=[], output_content_types=[])
 mock_agents = [mock_agent]
 mock_session = Session()
 mock_run = Run(

acp_sdk-0.12.3/tests/e2e/test_suites/test_discovery.py

@@ -1,24 +0,0 @@
-import pytest
-from acp_sdk.client import Client
-from acp_sdk.models import AgentManifest
-from acp_sdk.server import Server
-
-
-@pytest.mark.asyncio
-async def test_ping(server: Server, client: Client) -> None:
-    await client.ping()
-    assert True
-
-
-@pytest.mark.asyncio
-async def test_agents_list(server: Server, client: Client) -> None:
-    async for agent in client.agents():
-        assert isinstance(agent, AgentManifest)
-
-
-@pytest.mark.asyncio
-async def test_agents_manifest(server: Server, client: Client) -> None:
-    agent_name = "echo"
-    agent = await client.agent(name=agent_name)
-    assert isinstance(agent, AgentManifest)
-    assert agent.name == agent_name