adds error handling for agent.get

synapseclient/models/agent.py

@@ -641,7 +641,7 @@ async def get_async(self, *, synapse_client: Optional[Synapse] = None) -> "Agent
             The existing Agent object.
 
         Example: Get and chat with an existing agent
-            Retrieve an existing agent by providing the agent's registration ID and calling `get()`.
+            Retrieve an existing custom agent by providing the agent's registration ID and calling `get_async()`.
             Then, send a prompt to the agent.
 
                 import asyncio
@@ -661,6 +661,13 @@ async def main():
 
                 asyncio.run(main())
         """
+        if not self.registration_id:
+            raise ValueError(
+                "Registration ID is required to retrieve a custom agent. "
+                "If you are trying to use the baseline agent, you do not need to "
+                "use `get` or `get_async`. Instead, simply create an `Agent` object "
+                "and start prompting `my_agent = Agent(); my_agent.prompt(...)`.",
+            )
         agent_response = await get_agent(
             registration_id=self.registration_id,
             synapse_client=synapse_client,

tests/integration/synapseclient/models/async/test_agent_async.py

@@ -160,6 +160,13 @@ async def test_get(self) -> None:
         expected_agent = self.get_test_agent()
         assert agent == expected_agent
 
+    async def test_get_no_registration_id(self) -> None:
+        # GIVEN an Agent with no registration id
+        agent = Agent()
+        # WHEN I get the agent, I expect a ValueError to be raised
+        with pytest.raises(ValueError, match="Registration ID is required"):
+            await agent.get_async(synapse_client=self.syn)
+
     async def test_start_session(self) -> None:
         # GIVEN an Agent with a valid agent registration id
         agent = Agent(registration_id=AGENT_REGISTRATION_ID)

tests/integration/synapseclient/models/synchronous/test_agent.py

@@ -120,6 +120,13 @@ def test_get(self) -> None:
         expected_agent = self.get_test_agent()
         assert agent == expected_agent
 
+    def test_get_no_registration_id(self) -> None:
+        # GIVEN an Agent with no registration id
+        agent = Agent()
+        # WHEN I get the agent, I expect a ValueError to be raised
+        with pytest.raises(ValueError, match="Registration ID is required"):
+            agent.get(synapse_client=self.syn)
+
     def test_start_session(self) -> None:
         # GIVEN an Agent with a valid agent registration id
         agent = Agent(registration_id=AGENT_REGISTRATION_ID).get(