feat: make model representations LLM friendly (#119)

Author: mathislucka

src/deepset_mcp/api/indexes/models.py

@@ -2,6 +2,7 @@
 from typing import Any
 
 from pydantic import BaseModel
+from rich.repr import Result
 
 from deepset_mcp.api.shared_models import DeepsetUser
 
@@ -35,6 +36,24 @@ class Index(BaseModel):
     last_edited_by: DeepsetUser | None = None
     status: IndexStatus
 
+    def __rich_repr__(self) -> Result:
+        """Used to display the model in an LLM friendly way."""
+        yield "name", self.name
+        yield "description", self.description, None
+        yield "desired_status", self.desired_status
+        yield "status", self.status
+        yield "status", self.status
+        yield "created_by", f"{self.created_by.given_name} {self.created_by.family_name} ({self.created_by.id})"
+        yield "created_at", self.created_at.strftime("%m/%d/%Y %I:%M:%S %p")
+        yield (
+            "last_edited_by",
+            f"{self.last_edited_by.given_name} {self.last_edited_by.family_name} ({self.last_edited_by.id})"
+            if self.last_edited_by
+            else None,
+        )
+        yield "last_edited_at", self.last_edited_at.strftime("%m/%d/%Y %I:%M:%S %p") if self.last_edited_at else None
+        yield "config_yaml", self.config_yaml if self.config_yaml is not None else "Get full index to see config."
+
 
 class IndexList(BaseModel):
     """Response model for listing indexes."""

src/deepset_mcp/api/pipeline/models.py

@@ -4,6 +4,7 @@
 from uuid import UUID
 
 from pydantic import BaseModel, Field, model_validator
+from rich.repr import Result
 
 from deepset_mcp.api.shared_models import DeepsetUser
 
@@ -41,6 +42,22 @@ class Config:
             datetime: lambda dt: dt.isoformat()
         }
 
+    def __rich_repr__(self) -> Result:
+        """Used to display the model in an LLM friendly way."""
+        yield "name", self.name
+        yield "service_level", self.service_level.value
+        yield "status", self.status
+        yield "created_by", f"{self.created_by.given_name} {self.created_by.family_name} ({self.created_by.id})"
+        yield "created_at", self.created_at.strftime("%m/%d/%Y %I:%M:%S %p")
+        yield (
+            "last_updated_by",
+            f"{self.last_updated_by.given_name} {self.last_updated_by.family_name} ({self.last_updated_by.id})"
+            if self.last_updated_by
+            else None,
+        )
+        yield "last_updated_at", self.last_updated_at.strftime("%m/%d/%Y %I:%M:%S %p") if self.last_updated_at else None
+        yield "yaml_config", self.yaml_config if self.yaml_config is not None else "Get full pipeline to see config."
+
 
 class ValidationError(BaseModel):
     """Model representing a validation error from the pipeline validation API."""
@@ -55,6 +72,11 @@ class PipelineValidationResult(BaseModel):
     valid: bool
     errors: list[ValidationError] = []
 
+    def __rich_repr__(self) -> Result:
+        """Used to display the model in an LLM friendly way."""
+        yield "valid", self.valid
+        yield "errors", [f"{e.message} ({e.code})" for e in self.errors]
+
 
 class TraceFrame(BaseModel):
     """Model representing a single frame in a stack trace."""

src/deepset_mcp/tool_factory.py

@@ -80,7 +80,7 @@ def get_slice_from_object_store(
 
     :param object_id: Identifier of the object.
     :param start: Start index for slicing.
-    :param end: End index for slicing (None for end of sequence).
+    :param end: End index for slicing (optional - leave empty to get slice from start to end of sequence).
     :param path: Navigation path to object to slice (optional).
     :return: String representation of the slice.
     """

src/deepset_mcp/tools/tokonomics/explorer.py

@@ -32,9 +32,9 @@ class RichExplorer:
     def __init__(
         self,
         store: ObjectStore,
-        max_items: int = 20,
+        max_items: int = 25,
         max_string_length: int = 300,
-        max_depth: int = 3,
+        max_depth: int = 4,
         max_search_matches: int = 10,
         search_context_length: int = 150,
     ) -> None:

test/unit/tools/tokonomics/test_explorer.py

@@ -23,9 +23,9 @@ def test_init_default_params(self, store: ObjectStore) -> None:
         explorer = RichExplorer(store)
 
         assert explorer.store is store
-        assert explorer.max_items == 20
+        assert explorer.max_items == 25
         assert explorer.max_string_length == 300
-        assert explorer.max_depth == 3
+        assert explorer.max_depth == 4
         assert explorer.max_search_matches == 10
         assert explorer.search_context_length == 150
         assert explorer.console.options.is_terminal is False