feat: user agent should identify deepset mcp requests

Author: mathislucka

src/deepset_mcp/__init__.py

@@ -1,4 +1,9 @@
 # SPDX-FileCopyrightText: 2025-present deepset GmbH <info@deepset.ai>
 #
 # SPDX-License-Identifier: Apache-2.0
+import importlib.metadata
 
+try:
+    __version__ = importlib.metadata.version(__name__)
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0"  # Fallback for development mode

src/deepset_mcp/config.py

@@ -4,6 +4,8 @@
 
 """This module contains static configuration for the deepset MCP server."""
 
+from deepset_mcp import __version__
+
 # We need this mapping to which environment variables integrations are mapped to
 # The mapping is maintained in the pipeline operator:
 # https://github.com/deepset-ai/dc-pipeline-operator/blob/main/dc_operators/config.py#L279
@@ -27,3 +29,5 @@
 }
 
 DEEPSET_DOCS_DEFAULT_SHARE_URL = "https://cloud.deepset.ai/shared_prototypes?share_token=prototype_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3ODM0MjE0OTguNTk5LCJhdWQiOiJleHRlcm5hbCB1c2VyIiwiaXNzIjoiZEMiLCJ3b3Jrc3BhY2VfaWQiOiI4YzI0ZjExMi1iMjljLTQ5MWMtOTkzOS1hZTkxMDRhNTQyMWMiLCJ3b3Jrc3BhY2VfbmFtZSI6ImRjLWRvY3MtY29udGVudCIsIm9yZ2FuaXphdGlvbl9pZCI6ImNhOWYxNGQ0LWMyYzktNDYwZC04ZDI2LWY4Y2IwYWNhMDI0ZiIsInNoYXJlX2lkIjoiY2Y3MTA3ODAtOThmNi00MzlmLThiNzYtMmMwNDkyODNiMDZhIiwibG9naW5fcmVxdWlyZWQiOmZhbHNlfQ.5j6DCNRQ1_KB8lhIJqHyw2hBIleEW1_Y_UBuH6MTYY0"
+
+DEFAULT_CLIENT_HEADER = {"headers": {"User-Agent": f"deepset-mcp/{__version__}"}}

src/deepset_mcp/tool_factory.py

@@ -16,6 +16,7 @@
 from mcp.server.fastmcp import FastMCP
 
 from deepset_mcp.api.client import AsyncDeepsetClient
+from deepset_mcp.config import DEFAULT_CLIENT_HEADER
 from deepset_mcp.initialize_embedding_model import get_initialized_model
 from deepset_mcp.store import STORE
 from deepset_mcp.tools.custom_components import (
@@ -121,7 +122,9 @@ async def search_docs(query: str) -> str:
     :param query: The search query to execute against the documentation.
     :returns: The formatted search results from the documentation.
     """
-    async with AsyncDeepsetClient(api_key=os.environ["DEEPSET_DOCS_API_KEY"]) as client:
+    async with AsyncDeepsetClient(
+        api_key=os.environ["DEEPSET_DOCS_API_KEY"], transport_config=DEFAULT_CLIENT_HEADER
+    ) as client:
         response = await search_docs_tool(
             client=client,
             workspace=os.environ["DEEPSET_DOCS_WORKSPACE"],
@@ -377,22 +380,22 @@ async def func_with_custom_args(*args: Any, **kwargs: Any) -> Any:
 
                 async def workspace_environment_wrapper(**kwargs: Any) -> Any:
                     ws = workspace or get_workspace_from_env()
-                    async with AsyncDeepsetClient() as client:
+                    async with AsyncDeepsetClient(transport_config=DEFAULT_CLIENT_HEADER) as client:
                         return await decorated_func(client=client, workspace=ws, **kwargs)
 
                 wrapper = workspace_environment_wrapper
             else:  # DYNAMIC mode
 
                 async def workspace_explicit_wrapper(**kwargs: Any) -> Any:
-                    async with AsyncDeepsetClient() as client:
+                    async with AsyncDeepsetClient(transport_config=DEFAULT_CLIENT_HEADER) as client:
                         # The first argument is the workspace, which must be passed by keyword.
                         return await decorated_func(client=client, **kwargs)
 
                 wrapper = workspace_explicit_wrapper
         else:  # Client-only tools
 
             async def client_only_wrapper(**kwargs: Any) -> Any:
-                async with AsyncDeepsetClient() as client:
+                async with AsyncDeepsetClient(transport_config=DEFAULT_CLIENT_HEADER) as client:
                     return await decorated_func(client=client, **kwargs)
 
             wrapper = client_only_wrapper