feat: add resource for secrets (#102)

* feat: add resource for secrets

* chore: use NoContentResponse for Secret resource

Author: mathislucka

src/deepset_mcp/api/client.py

@@ -10,6 +10,7 @@
 from deepset_mcp.api.pipeline.resource import PipelineResource
 from deepset_mcp.api.pipeline_template.resource import PipelineTemplateResource
 from deepset_mcp.api.protocols import AsyncClientProtocol
+from deepset_mcp.api.secrets.resource import SecretResource
 from deepset_mcp.api.transport import (
     AsyncTransport,
     StreamingResponse,
@@ -253,3 +254,7 @@ def custom_components(self, workspace: str) -> CustomComponentsResource:
     def users(self) -> UserResource:
         """Resource to interact with users."""
         return UserResource(client=self)
+
+    def secrets(self) -> SecretResource:
+        """Resource to interact with secrets."""
+        return SecretResource(client=self)

src/deepset_mcp/api/pipeline/__init__.py

@@ -1,6 +1,5 @@
 from .models import (
     DeepsetPipeline,
-    NoContentResponse,
     PipelineLog,
     PipelineLogList,
     PipelineValidationResult,
@@ -10,7 +9,6 @@
 
 __all__ = [
     "DeepsetPipeline",
-    "NoContentResponse",
     "PipelineValidationResult",
     "ValidationError",
     "PipelineResource",

src/deepset_mcp/api/pipeline/models.py

@@ -56,13 +56,6 @@ class PipelineValidationResult(BaseModel):
     errors: list[ValidationError] = []
 
 
-class NoContentResponse(BaseModel):
-    """Response model for an empty response."""
-
-    success: bool = True
-    message: str = "No content"
-
-
 class TraceFrame(BaseModel):
     """Model representing a single frame in a stack trace."""
 

src/deepset_mcp/api/pipeline/resource.py

@@ -9,11 +9,11 @@
     DeepsetPipeline,
     DeepsetSearchResponse,
     DeepsetStreamEvent,
-    NoContentResponse,
     PipelineLogList,
     PipelineValidationResult,
     ValidationError,
 )
+from deepset_mcp.api.shared_models import NoContentResponse
 from deepset_mcp.api.transport import raise_for_status
 
 logger = logging.getLogger(__name__)

src/deepset_mcp/api/protocols.py

@@ -10,12 +10,12 @@
     DeepsetPipeline,
     DeepsetSearchResponse,
     DeepsetStreamEvent,
-    NoContentResponse,
     PipelineLogList,
     PipelineValidationResult,
 )
 from deepset_mcp.api.pipeline_template.models import PipelineTemplate
-from deepset_mcp.api.shared_models import DeepsetUser
+from deepset_mcp.api.secrets.models import Secret, SecretList
+from deepset_mcp.api.shared_models import DeepsetUser, NoContentResponse
 from deepset_mcp.api.transport import StreamingResponse, TransportResponse
 
 
@@ -53,6 +53,31 @@ async def get(self, user_id: str) -> DeepsetUser:
         ...
 
 
+class SecretResourceProtocol(Protocol):
+    """Protocol defining the implementation for SecretResource."""
+
+    async def list(
+        self,
+        limit: int = 10,
+        field: str = "created_at",
+        order: str = "DESC",
+    ) -> SecretList:
+        """List secrets with pagination."""
+        ...
+
+    async def create(self, name: str, secret: str) -> NoContentResponse:
+        """Create a new secret."""
+        ...
+
+    async def get(self, secret_id: str) -> Secret:
+        """Get a specific secret by ID."""
+        ...
+
+    async def delete(self, secret_id: str) -> NoContentResponse:
+        """Delete a secret by ID."""
+        ...
+
+
 T = TypeVar("T")
 
 
@@ -146,6 +171,10 @@ def users(self) -> "UserResourceProtocol":
         """Access users."""
         ...
 
+    def secrets(self) -> "SecretResourceProtocol":
+        """Access secrets."""
+        ...
+
 
 class IndexResourceProtocol(Protocol):
     """Protocol defining the implementation for IndexResource."""

src/deepset_mcp/api/secrets/__init__.py

@@ -0,0 +1,16 @@
+from pydantic import BaseModel
+
+
+class Secret(BaseModel):
+    """Model representing a secret in deepset."""
+
+    name: str
+    secret_id: str
+
+
+class SecretList(BaseModel):
+    """Model representing a list of secrets with pagination."""
+
+    data: list[Secret]
+    has_more: bool
+    total: int

src/deepset_mcp/api/secrets/models.py

@@ -0,0 +1,111 @@
+from typing import Any
+
+from deepset_mcp.api.exceptions import ResourceNotFoundError
+from deepset_mcp.api.protocols import AsyncClientProtocol, SecretResourceProtocol
+from deepset_mcp.api.secrets.models import Secret, SecretList
+from deepset_mcp.api.shared_models import NoContentResponse
+from deepset_mcp.api.transport import raise_for_status
+
+
+class SecretResource(SecretResourceProtocol):
+    """Resource for managing secrets in deepset."""
+
+    def __init__(self, client: AsyncClientProtocol) -> None:
+        """Initialize a SecretResource.
+
+        :param client: The API client to use for requests.
+        """
+        self._client = client
+
+    async def list(
+        self,
+        limit: int = 10,
+        field: str = "created_at",
+        order: str = "DESC",
+    ) -> SecretList:
+        """List secrets with pagination.
+
+        :param limit: Maximum number of secrets to return.
+        :param field: Field to sort by.
+        :param order: Sort order (ASC or DESC).
+
+        :returns: List of secrets with pagination info.
+        """
+        params = {
+            "limit": str(limit),
+            "field": field,
+            "order": order,
+        }
+
+        resp = await self._client.request(
+            endpoint="v2/secrets",
+            method="GET",
+            response_type=dict[str, Any],
+            params=params,
+        )
+
+        raise_for_status(resp)
+
+        if resp.json is None:
+            raise ResourceNotFoundError("Failed to retrieve secrets.")
+
+        return SecretList(**resp.json)
+
+    async def create(self, name: str, secret: str) -> NoContentResponse:
+        """Create a new secret.
+
+        :param name: The name of the secret.
+        :param secret: The secret value.
+
+        :returns: NoContentResponse indicating successful creation.
+        """
+        data = {
+            "name": name,
+            "secret": secret,
+        }
+
+        resp = await self._client.request(
+            endpoint="v2/secrets",
+            method="POST",
+            data=data,
+            response_type=None,
+        )
+
+        raise_for_status(resp)
+        return NoContentResponse(message="Secret created successfully.")
+
+    async def get(self, secret_id: str) -> Secret:
+        """Get a specific secret by ID.
+
+        :param secret_id: The ID of the secret to retrieve.
+
+        :returns: Secret information.
+        """
+        resp = await self._client.request(
+            endpoint=f"v2/secrets/{secret_id}",
+            method="GET",
+            response_type=dict[str, Any],
+        )
+
+        raise_for_status(resp)
+
+        if resp.json is None:
+            raise ResourceNotFoundError(f"Secret '{secret_id}' not found.")
+
+        return Secret(**resp.json)
+
+    async def delete(self, secret_id: str) -> NoContentResponse:
+        """Delete a secret by ID.
+
+        :param secret_id: The ID of the secret to delete.
+
+        :returns: NoContentResponse indicating successful deletion.
+        """
+        resp = await self._client.request(
+            endpoint=f"v2/secrets/{secret_id}",
+            method="DELETE",
+            response_type=None,
+        )
+
+        raise_for_status(resp)
+        return NoContentResponse(message="Secret deleted successfully.")

src/deepset_mcp/api/secrets/resource.py

@@ -1,6 +1,13 @@
 from pydantic import BaseModel, Field
 
 
+class NoContentResponse(BaseModel):
+    """Response model for an empty response."""
+
+    success: bool = True
+    message: str = "No content"
+
+
 class DeepsetUser(BaseModel):
     """Model representing a user on the deepset platform."""