Rename agent_instance_id to agentic_app_id throughout codebase

Author: sellakumaran

libraries/microsoft-agents-a365-tooling-extensions-agentframework/README.md

@@ -82,7 +82,7 @@ async def main():
         chat_client=chat_client,
         agent_instructions="You are a helpful assistant that can provide weather and restaurant information.",
         initial_tools=[],  # Your existing tools
-        agent_instance_id="user-123",
+        agentic_app_id="user-123",
         environment_id="prod",
         auth_token="your-auth-token"
     )
@@ -139,7 +139,7 @@ async def main():
         loaded from configured servers. Use these tools to enhance your capabilities.
         """,
         initial_tools=existing_tools,
-        agent_instance_id="user-123",
+        agentic_app_id="user-123",
         environment_id="production",
         auth_token="your-auth-token"
     )
@@ -190,7 +190,7 @@ agent = await service.add_tool_servers_to_agent(
     chat_client=chat_client,
     agent_instructions="You are a helpful assistant with access to various tools.",
     initial_tools=[],  # Your existing tools
-    agent_instance_id="user-123",
+    agentic_app_id="user-123",
     environment_id="prod",
     auth_token="your-token"
 )

libraries/microsoft-agents-a365-tooling-extensions-agentframework/microsoft_agents_a365/tooling/extensions/agentframework/services/mcp_tool_registration_service.py

@@ -41,7 +41,7 @@ async def add_tool_servers_to_agent(
         chat_client: Union[OpenAIChatClient, AzureOpenAIChatClient],
         agent_instructions: str,
         initial_tools: List[Any],
-        agent_instance_id: str,
+        agentic_app_id: str,
         environment_id: str,
         auth: Optional[Authorization] = None,
         auth_token: Optional[str] = None,
@@ -54,7 +54,7 @@ async def add_tool_servers_to_agent(
             chat_client: The chat client instance (Union[OpenAIChatClient, AzureOpenAIChatClient])
             agent_instructions: Instructions for the agent behavior
             initial_tools: List of initial tools to add to the agent
-            agent_instance_id: Unique identifier for the agent instance
+            agentic_app_id: Agentic app identifier for the agent
             environment_id: Environment identifier for MCP server discovery
             auth: Optional authorization context
             auth_token: Optional bearer token for authentication
@@ -65,18 +65,12 @@ async def add_tool_servers_to_agent(
         """
         try:
             self._logger.info(
-                f"Listing MCP tool servers for agent {agent_instance_id} in environment {environment_id}"
+                f"Listing MCP tool servers for agent {agentic_app_id} in environment {environment_id}"
             )
 
-            agentic_app_id = agent_instance_id
-            if turn_context and turn_context.activity and turn_context.activity.recipient:
-                agentic_app_id = getattr(
-                    turn_context.activity.recipient, "agentic_app_id", agent_instance_id
-                )
-
             # Get MCP server configurations
             server_configs = await self._mcp_server_configuration_service.list_tool_servers(
-                agent_instance_id=agentic_app_id,
+                agentic_app_id=agentic_app_id,
                 environment_id=environment_id,
                 auth_token=auth_token,
             )

libraries/microsoft-agents-a365-tooling-extensions-azureaifoundry/microsoft_agents_a365/tooling/extensions/azureaifoundry/services/mcp_tool_registration_service.py

@@ -72,7 +72,7 @@ def __init__(
     async def add_tool_servers_to_agent(
         self,
         project_client: "AIProjectClient",
-        agent_instance_id: str,
+        agentic_app_id: str,
         environment_id: str,
         auth: Authorization,
         context: TurnContext,
@@ -83,7 +83,7 @@ async def add_tool_servers_to_agent(
 
         Args:
             project_client: The Azure Foundry AIProjectClient instance.
-            agent_instance_id: Agent Instance ID for the agent.
+            agentic_app_id: Agentic App ID for the agent.
             environment_id: Environment ID for the environment.
             auth_token: Authentication token to access the MCP servers.
 
@@ -102,12 +102,12 @@ async def add_tool_servers_to_agent(
         try:
             # Get the tool definitions and resources using the async implementation
             tool_definitions, tool_resources = await self._get_mcp_tool_definitions_and_resources(
-                agent_instance_id, environment_id, auth_token or ""
+                agentic_app_id, environment_id, auth_token or ""
             )
 
             # Update the agent with the tools
             project_client.agents.update_agent(
-                agent_instance_id, tools=tool_definitions, tool_resources=tool_resources
+                agentic_app_id, tools=tool_definitions, tool_resources=tool_resources
             )
 
             self._logger.info(
@@ -116,20 +116,20 @@ async def add_tool_servers_to_agent(
 
         except Exception as ex:
             self._logger.error(
-                f"Unhandled failure during MCP tool registration workflow for agent user {agent_instance_id}: {ex}"
+                f"Unhandled failure during MCP tool registration workflow for agent user {agentic_app_id}: {ex}"
             )
             raise
 
     async def _get_mcp_tool_definitions_and_resources(
-        self, agent_instance_id: str, environment_id: str, auth_token: str
+        self, agentic_app_id: str, environment_id: str, auth_token: str
     ) -> Tuple[List[McpTool], Optional[ToolResources]]:
         """
         Internal method to get MCP tool definitions and resources.
 
         This implements the core logic equivalent to the C# method of the same name.
 
         Args:
-            agent_instance_id: Agent Instance ID for the agent.
+            agentic_app_id: Agentic App ID for the agent.
             environment_id: Environment ID for the environment.
             auth_token: Authentication token to access the MCP servers.
 
@@ -143,17 +143,17 @@ async def _get_mcp_tool_definitions_and_resources(
         # Get MCP server configurations
         try:
             servers = await self._mcp_server_configuration_service.list_tool_servers(
-                agent_instance_id, environment_id, auth_token
+                agentic_app_id, environment_id, auth_token
             )
         except Exception as ex:
             self._logger.error(
-                f"Failed to list MCP tool servers for AgentInstanceId={agent_instance_id}: {ex}"
+                f"Failed to list MCP tool servers for AgenticAppId={agentic_app_id}: {ex}"
             )
             return ([], None)
 
         if len(servers) == 0:
             self._logger.info(
-                f"No MCP servers configured for AgentInstanceId={agent_instance_id}, EnvironmentId={environment_id}"
+                f"No MCP servers configured for AgenticAppId={agentic_app_id}, EnvironmentId={environment_id}"
             )
             return ([], None)
 

libraries/microsoft-agents-a365-tooling-extensions-openai/README.md

@@ -53,7 +53,7 @@ registration_service = McpToolRegistrationService()
 # Add MCP tool servers to your OpenAI agent
 await registration_service.add_tool_servers_to_agent(
     agent=your_openai_agent,
-    agent_instance_id="user-123",
+    agentic_app_id="user-123",
     environment_id="prod",
     auth=authorization_context,
     context=turn_context,

libraries/microsoft-agents-a365-tooling-extensions-openai/microsoft_agents_a365/tooling/extensions/openai/mcp_tool_registration_service.py

@@ -51,7 +51,7 @@ def __init__(self, logger: Optional[logging.Logger] = None):
     async def add_tool_servers_to_agent(
         self,
         agent: Agent,
-        agent_instance_id: str,
+        agentic_app_id: str,
         environment_id: str,
         auth: Authorization,
         context: TurnContext,
@@ -66,7 +66,7 @@ async def add_tool_servers_to_agent(
 
         Args:
             agent: The existing agent to add servers to
-            agent_instance_id: Agent Instance ID for the agent
+            agentic_app_id: Agentic App ID for the agent
             environment_id: Environment ID for the environment
             auth_token: Authentication token to access the MCP servers
 
@@ -83,10 +83,10 @@ async def add_tool_servers_to_agent(
         # mcp_server_configs = []
         # TODO: radevika: Update once the common project is merged.
         self._logger.info(
-            f"Listing MCP tool servers for agent {agent_instance_id} in environment {environment_id}"
+            f"Listing MCP tool servers for agent {agentic_app_id} in environment {environment_id}"
         )
         mcp_server_configs = await self.config_service.list_tool_servers(
-            agent_instance_id=agent_instance_id,
+            agentic_app_id=agentic_app_id,
             environment_id=environment_id,
             auth_token=auth_token,
         )

libraries/microsoft-agents-a365-tooling-extensions-semantickernel/README.md

@@ -55,7 +55,7 @@ registration_service = McpToolRegistrationService()
 # Add MCP tool servers to your Semantic Kernel
 await registration_service.add_tool_servers_to_kernel(
     kernel=kernel,
-    agent_instance_id="user-123",
+    agentic_app_id="user-123",
     environment_id="prod",
     auth_token="your-auth-token"
 )

libraries/microsoft-agents-a365-tooling-extensions-semantickernel/microsoft_agents_a365/tooling/extensions/semantickernel/services/mcp_tool_registration_service.py

@@ -84,7 +84,7 @@ def __init__(
     async def add_tool_servers_to_agent(
         self,
         kernel: sk.Kernel,
-        agent_instance_id: str,
+        agentic_app_id: str,
         environment_id: str,
         auth: Authorization,
         context: TurnContext,
@@ -95,7 +95,7 @@ async def add_tool_servers_to_agent(
 
         Args:
             kernel: The Semantic Kernel instance to which the tools will be added.
-            agent_instance_id: Agent Instance ID for the agent.
+            agentic_app_id: Agentic App ID for the agent.
             environment_id: Environment ID for the environment.
             auth_token: Authentication token to access the MCP servers.
 
@@ -109,11 +109,11 @@ async def add_tool_servers_to_agent(
             authToken = await auth.exchange_token(context, scopes, "AGENTIC")
             auth_token = authToken.token
 
-        self._validate_inputs(kernel, agent_instance_id, environment_id, auth_token)
+        self._validate_inputs(kernel, agentic_app_id, environment_id, auth_token)
 
         # Get and process servers
         servers = await self._mcp_server_configuration_service.list_tool_servers(
-            agent_instance_id, environment_id, auth_token
+            agentic_app_id, environment_id, auth_token
         )
         self._logger.info(f"🔧 Adding MCP tools from {len(servers)} servers")
 
@@ -178,13 +178,13 @@ async def add_tool_servers_to_agent(
     # ============================================================================
 
     def _validate_inputs(
-        self, kernel: Any, agent_instance_id: str, environment_id: str, auth_token: str
+        self, kernel: Any, agentic_app_id: str, environment_id: str, auth_token: str
     ) -> None:
         """Validate all required inputs."""
         if kernel is None:
             raise ValueError("kernel cannot be None")
-        if not agent_instance_id or not agent_instance_id.strip():
-            raise ValueError("agent_instance_id cannot be null or empty")
+        if not agentic_app_id or not agentic_app_id.strip():
+            raise ValueError("agentic_app_id cannot be null or empty")
         if not environment_id or not environment_id.strip():
             raise ValueError("environment_id cannot be null or empty")
         if not auth_token or not auth_token.strip():

libraries/microsoft-agents-a365-tooling/README.md

@@ -58,7 +58,7 @@ mcp_config = MCPServerConfig(
 # Use configuration service to list available MCP servers
 config_service = McpToolServerConfigurationService()
 mcp_servers = await config_service.list_tool_servers(
-    agent_instance_id="agent-123",
+    agentic_app_id="agent-123",
     environment_id="prod",
     auth_token="your-auth-token"
 )

libraries/microsoft-agents-a365-tooling/microsoft_agents_a365/tooling/services/mcp_tool_server_configuration_service.py

@@ -70,13 +70,13 @@ def __init__(self, logger: Optional[logging.Logger] = None):
     # --------------------------------------------------------------------------
 
     async def list_tool_servers(
-        self, agent_instance_id: str, environment_id: str, auth_token: str
+        self, agentic_app_id: str, environment_id: str, auth_token: str
     ) -> List[MCPServerConfig]:
         """
         Gets the list of MCP Servers that are configured for the agent.
 
         Args:
-            agent_instance_id: Agent Instance ID for the agent.
+            agentic_app_id: Agentic App ID for the agent.
             environment_id: Environment ID for the environment.
             auth_token: Authentication token to access the MCP servers.
 
@@ -88,18 +88,18 @@ async def list_tool_servers(
             Exception: If there's an error communicating with the tooling gateway.
         """
         # Validate input parameters
-        self._validate_input_parameters(agent_instance_id, environment_id, auth_token)
+        self._validate_input_parameters(agentic_app_id, environment_id, auth_token)
 
         self._logger.info(
-            f"Listing MCP tool servers for agent {agent_instance_id} in environment {environment_id}"
+            f"Listing MCP tool servers for agent {agentic_app_id} in environment {environment_id}"
         )
 
         # Determine configuration source based on environment
         if self._is_development_scenario():
             return self._load_servers_from_manifest(environment_id)
         else:
             return await self._load_servers_from_gateway(
-                agent_instance_id, environment_id, auth_token
+                agentic_app_id, environment_id, auth_token
             )
 
     # --------------------------------------------------------------------------
@@ -292,13 +292,13 @@ def _log_manifest_search_failure(self) -> None:
     # --------------------------------------------------------------------------
 
     async def _load_servers_from_gateway(
-        self, agent_instance_id: str, environment_id: str, auth_token: str
+        self, agentic_app_id: str, environment_id: str, auth_token: str
     ) -> List[MCPServerConfig]:
         """
         Reads MCP server configurations from tooling gateway endpoint for production scenario.
 
         Args:
-            agent_instance_id: Agent Instance ID for the agent.
+            agentic_app_id: Agentic App ID for the agent.
             environment_id: Environment ID for the environment.
             auth_token: Authentication token to access the tooling gateway.
 
@@ -311,7 +311,7 @@ async def _load_servers_from_gateway(
         mcp_servers: List[MCPServerConfig] = []
 
         try:
-            config_endpoint = get_tooling_gateway_for_digital_worker(agent_instance_id)
+            config_endpoint = get_tooling_gateway_for_digital_worker(agentic_app_id)
             headers = self._prepare_gateway_headers(auth_token, environment_id)
 
             self._logger.info(f"Calling tooling gateway endpoint: {config_endpoint}")
@@ -447,21 +447,21 @@ def _parse_gateway_server_config(
     # --------------------------------------------------------------------------
 
     def _validate_input_parameters(
-        self, agent_instance_id: str, environment_id: str, auth_token: str
+        self, agentic_app_id: str, environment_id: str, auth_token: str
     ) -> None:
         """
         Validates input parameters for the main API method.
 
         Args:
-            agent_instance_id: Agent Instance ID to validate.
+            agentic_app_id: Agentic App ID to validate.
             environment_id: Environment ID to validate.
             auth_token: Authentication token to validate.
 
         Raises:
             ValueError: If any parameter is invalid or empty.
         """
-        if not agent_instance_id:
-            raise ValueError("agent_instance_id cannot be empty or None")
+        if not agentic_app_id:
+            raise ValueError("agentic_app_id cannot be empty or None")
         if not environment_id:
             raise ValueError("environment_id cannot be empty or None")
         if not auth_token:

libraries/microsoft-agents-a365-tooling/microsoft_agents_a365/tooling/utils/utility.py

@@ -22,18 +22,18 @@ class ToolsMode(Enum):
 PROD_MCP_PLATFORM_AUTHENTICATION_SCOPE = "ea9ffc3e-8a23-4a7d-836d-234d7c7565c1/.default"
 
 
-def get_tooling_gateway_for_digital_worker(agent_instance_id: str) -> str:
+def get_tooling_gateway_for_digital_worker(agentic_app_id: str) -> str:
     """
     Gets the tooling gateway URL for the specified digital worker.
 
     Args:
-        agent_instance_id: The unique identifier of the digital worker.
+        agentic_app_id: The agentic app identifier of the digital worker.
 
     Returns:
         str: The tooling gateway URL for the digital worker.
     """
     # The endpoint needs to be updated based on the environment (prod, dev, etc.)
-    return f"{_get_mcp_platform_base_url()}/agents/{agent_instance_id}/mcpServers"
+    return f"{_get_mcp_platform_base_url()}/agents/{agentic_app_id}/mcpServers"
 
 
 def get_mcp_base_url() -> str: