From 40995a37aeb361fa432057c5a9ac1bdd77aaaeb5 Mon Sep 17 00:00:00 2001
From: openhands <openhands@all-hands.dev>
Date: Tue, 25 Nov 2025 20:07:06 +0000
Subject: [PATCH] Update SDK documentation examples to use
 conversation.set_security_analyzer

- Fix security analyzer examples in security.mdx to use conversation.set_security_analyzer() instead of deprecated Agent parameter
- Update MCP integration example to use new security analyzer API
- Update custom security analyzer example to use new API
- This aligns with the deprecation of security_analyzer parameter in Agent constructor

Co-authored-by: openhands <openhands@all-hands.dev>
---
 sdk/guides/mcp.mdx      |  3 ++-
 sdk/guides/security.mdx | 27 +++++++++++++++++----------
 2 files changed, 19 insertions(+), 11 deletions(-)

diff --git a/sdk/guides/mcp.mdx b/sdk/guides/mcp.mdx
index 32b5c1af..835b1733 100644
--- a/sdk/guides/mcp.mdx
+++ b/sdk/guides/mcp.mdx
@@ -67,7 +67,6 @@ agent = Agent(
     mcp_config=mcp_config,
     # This regex filters out all repomix tools except pack_codebase
     filter_tools_regex="^(?!repomix)(.*)|^repomix.*pack_codebase.*$",
-    security_analyzer=LLMSecurityAnalyzer(),
 )
 
 llm_messages = []  # collect raw LLM messages
@@ -84,6 +83,8 @@ conversation = Conversation(
     callbacks=[conversation_callback],
     workspace=cwd,
 )
+# Set security analyzer via conversation (new approach after deprecation)
+conversation.set_security_analyzer(LLMSecurityAnalyzer())
 
 logger.info("Starting conversation with MCP integration...")
 conversation.send_message(
diff --git a/sdk/guides/security.mdx b/sdk/guides/security.mdx
index 54b68764..2881e9f1 100644
--- a/sdk/guides/security.mdx
+++ b/sdk/guides/security.mdx
@@ -32,6 +32,7 @@ from openhands.sdk.conversation.state import (
     ConversationState,
 )
 from openhands.sdk.security.confirmation_policy import AlwaysConfirm, NeverConfirm
+from openhands.sdk.security.llm_analyzer import LLMSecurityAnalyzer
 from openhands.tools.preset.default import get_default_agent
 
 
@@ -111,11 +112,14 @@ llm = LLM(
     api_key=SecretStr(api_key),
 )
 
+agent = get_default_agent(llm=llm)
+conversation = Conversation(agent=agent, workspace=os.getcwd())
+
+# Conditionally add security analyzer based on environment variable
 add_security_analyzer = bool(os.getenv("ADD_SECURITY_ANALYZER", "").strip())
 if add_security_analyzer:
     print("Agent security analyzer added.")
-agent = get_default_agent(llm=llm, add_security_analyzer=add_security_analyzer)
-conversation = Conversation(agent=agent, workspace=os.getcwd())
+    conversation.set_security_analyzer(LLMSecurityAnalyzer())
 
 # 1) Confirmation mode ON
 conversation.set_confirmation_policy(AlwaysConfirm())
@@ -342,14 +346,15 @@ tools = [
     Tool(name=FileEditorTool.name),
 ]
 
-# Agent with security analyzer
-security_analyzer = LLMSecurityAnalyzer()
-agent = Agent(llm=llm, tools=tools, security_analyzer=security_analyzer)
+# Agent
+agent = Agent(llm=llm, tools=tools)
 
 # Conversation with persisted filestore
 conversation = Conversation(
     agent=agent, persistence_dir="./.conversations", workspace="."
 )
+# Set security analyzer via conversation (new approach after deprecation)
+conversation.set_security_analyzer(LLMSecurityAnalyzer())
 conversation.set_confirmation_policy(ConfirmRisky())
 
 print("\n1) Safe command (LOW risk - should execute automatically)...")
@@ -373,7 +378,7 @@ uv run python examples/01_standalone_sdk/16_llm_security_analyzer.py
 
 Create an LLM-based security analyzer to review actions before execution:
 
-```python highlight={9}
+```python highlight={9-11}
 from openhands.sdk import LLM
 from openhands.sdk.security.llm_analyzer import LLMSecurityAnalyzer
 llm = LLM(
@@ -382,8 +387,9 @@ llm = LLM(
     base_url=base_url,
     api_key=SecretStr(api_key),
 )
-security_analyzer = LLMSecurityAnalyzer(llm=security_llm)
-agent = Agent(llm=llm, tools=tools, security_analyzer=security_analyzer)
+agent = Agent(llm=llm, tools=tools)
+conversation = Conversation(agent=agent, workspace=".")
+conversation.set_security_analyzer(LLMSecurityAnalyzer(llm=security_llm))
 ```
 
 The security analyzer:
@@ -432,8 +438,9 @@ class CustomSecurityAnalyzer(SecurityAnalyzerBase):
         return SecurityRisk.LOW
 
 # Use your custom analyzer
-security_analyzer = CustomSecurityAnalyzer()
-agent = Agent(llm=llm, tools=tools, security_analyzer=security_analyzer)
+agent = Agent(llm=llm, tools=tools)
+conversation = Conversation(agent=agent, workspace=".")
+conversation.set_security_analyzer(CustomSecurityAnalyzer())
 ```
 
 For more details on the base class implementation, see the [source code](https://github.com/OpenHands/software-agent-sdk/blob/main/openhands-sdk/openhands/sdk/security/analyzer.py).