Update docstrings and fix README

Author: h3xxit

README.md

@@ -7,7 +7,7 @@
 
 ## Introduction
 
-The Universal Tool Calling Protocol (UTCP) is a modern, flexible, and scalable standard for defining and interacting with tools across a wide variety of communication protocols. UTCP 1.0.0 introduces a modular core with a plugin-based architecture, making it more extensible, testable, and easier to package.
+The Universal Tool Calling Protocol (UTCP) is a secure, scalable standard for defining and interacting with tools across a wide variety of communication protocols. UTCP 1.0.0 introduces a modular core with a plugin-based architecture, making it more extensible, testable, and easier to package.
 
 In contrast to other protocols, UTCP places a strong emphasis on:
 
@@ -87,7 +87,7 @@ Version 1.0.0 introduces several breaking changes. Follow these steps to migrate
 3.  **Update Imports**: Change your imports to reflect the new modular structure. For example, `from utcp.client.transport_interfaces.http_transport import HttpProvider` becomes `from utcp_http.http_call_template import HttpCallTemplate`.
 4.  **Tool Search**: If you were using the default search, the new strategy is `TagAndDescriptionWordMatchStrategy`. This is the new default and requires no changes unless you were implementing a custom strategy.
 5.  **Tool Naming**: Tool names are now namespaced as `manual_name.tool_name`. The client handles this automatically.
-6   **Variable Substitution Namespacing**: Variables that are subsituted in different `call_templates`, are first namespaced with the name of the manual with the `_` duplicated. So a key in a tool call template called `API_KEY` from the manual `manual_1` would be converted to `manual__1_API_KEY`.
+6.  **Variable Substitution Namespacing**: Variables that are substituted in different `call_templates`, are first namespaced with the name of the manual with the `_` duplicated. So a key in a tool call template called `API_KEY` from the manual `manual_1` would be converted to `manual__1_API_KEY`.
 
 ## Usage Examples
 
@@ -226,7 +226,7 @@ if __name__ == "__main__":
 
 ### 2. Providing a UTCP Manual
 
-A `UTCPManual` describes the tools you offer. The key change is replacing `tool_provider` with `call_template`.
+A `UTCPManual` describes the tools you offer. The key change is replacing `tool_provider` with `tool_call_template`.
 
 **`server.py`**
 
@@ -288,7 +288,7 @@ def utcp_discovery():
                         "conditions": {"type": "string"}
                     }
                 },
-                "call_template": {
+                "tool_call_template": {
                     "call_template_type": "http",
                     "url": "https://example.com/api/weather",
                     "http_method": "GET"
@@ -311,7 +311,7 @@ You can find full examples in the [examples repository](https://github.com/unive
 
 ### `UtcpManual` and `Tool` Models
 
-The `tool_provider` object inside a `Tool` has been replaced by `call_template`.
+The `tool_provider` object inside a `Tool` has been replaced by `tool_call_template`.
 
 ```json
 {
@@ -324,7 +324,7 @@ The `tool_provider` object inside a `Tool` has been replaced by `call_template`.
       "inputs": { ... },
       "outputs": { ... },
       "tags": ["string"],
-      "call_template": {
+      "tool_call_template": {
         "call_template_type": "http",
         "url": "https://...",
         "http_method": "GET"

core/src/utcp/data/auth.py

@@ -11,20 +11,48 @@
 import traceback
 
 class Auth(BaseModel, ABC):
-    """Authentication details for a provider.
+    """REQUIRED
+    Authentication details for a provider.
 
     Attributes:
         auth_type: The authentication type identifier.
     """
     auth_type: str
 
 class AuthSerializer(Serializer[Auth]):
+    """REQUIRED
+    Serializer for authentication details.
+
+    Defines the contract for serializers that convert authentication details to and from
+    dictionaries for storage or transmission. Serializers are responsible for:
+    - Converting authentication details to dictionaries for storage or transmission
+    - Converting dictionaries back to authentication details
+    - Ensuring data consistency during serialization and deserialization
+    """
     auth_serializers: dict[str, Serializer[Auth]] = {}
 
     def to_dict(self, obj: Auth) -> dict:
+        """REQUIRED
+        Convert an Auth object to a dictionary.
+
+        Args:
+            obj: The Auth object to convert.
+
+        Returns:
+            The dictionary converted from the Auth object.
+        """
         return AuthSerializer.auth_serializers[obj.auth_type].to_dict(obj)
 
     def validate_dict(self, obj: dict) -> Auth:
+        """REQUIRED
+        Validate a dictionary and convert it to an Auth object.
+
+        Args:
+            obj: The dictionary to validate and convert.
+
+        Returns:
+            The Auth object converted from the dictionary.
+        """
         try:
             return AuthSerializer.auth_serializers[obj["auth_type"]].validate_dict(obj)
         except KeyError:

core/src/utcp/data/auth_implementations/api_key_auth.py

@@ -5,7 +5,8 @@
 from utcp.exceptions import UtcpSerializerValidationError
 
 class ApiKeyAuth(Auth):
-    """Authentication using an API key.
+    """REQUIRED
+    Authentication using an API key.
 
     The key can be provided directly or sourced from an environment variable.
     Supports placement in headers, query parameters, or cookies.
@@ -30,10 +31,30 @@ class ApiKeyAuth(Auth):
 
 
 class ApiKeyAuthSerializer(Serializer[ApiKeyAuth]):
+    """REQUIRED
+    Serializer for ApiKeyAuth model."""
     def to_dict(self, obj: ApiKeyAuth) -> dict:
+        """REQUIRED
+        Convert an ApiKeyAuth object to a dictionary.
+
+        Args:
+            obj: The ApiKeyAuth object to convert.
+
+        Returns:
+            The dictionary converted from the ApiKeyAuth object.
+        """
         return obj.model_dump()
 
     def validate_dict(self, obj: dict) -> ApiKeyAuth:
+        """REQUIRED
+        Validate a dictionary and convert it to an ApiKeyAuth object.
+
+        Args:
+            obj: The dictionary to validate and convert.
+
+        Returns:
+            The ApiKeyAuth object converted from the dictionary.
+        """
         try:
             return ApiKeyAuth.model_validate(obj)
         except ValidationError as e:

core/src/utcp/data/auth_implementations/basic_auth.py

@@ -5,7 +5,8 @@
 from utcp.exceptions import UtcpSerializerValidationError
 
 class BasicAuth(Auth):
-    """Authentication using HTTP Basic Authentication.
+    """REQUIRED
+    Authentication using HTTP Basic Authentication.
 
     Uses the standard HTTP Basic Authentication scheme with username and password
     encoded in the Authorization header.
@@ -22,10 +23,30 @@ class BasicAuth(Auth):
 
 
 class BasicAuthSerializer(Serializer[BasicAuth]):
+    """REQUIRED
+    Serializer for BasicAuth model."""
     def to_dict(self, obj: BasicAuth) -> dict:
+        """REQUIRED
+        Convert a BasicAuth object to a dictionary.
+
+        Args:
+            obj: The BasicAuth object to convert.
+
+        Returns:
+            The dictionary converted from the BasicAuth object.
+        """
         return obj.model_dump()
 
     def validate_dict(self, obj: dict) -> BasicAuth:
+        """REQUIRED
+        Validate a dictionary and convert it to a BasicAuth object.
+
+        Args:
+            obj: The dictionary to validate and convert.
+
+        Returns:
+            The BasicAuth object converted from the dictionary.
+        """
         try:
             return BasicAuth.model_validate(obj)
         except ValidationError as e:

core/src/utcp/data/auth_implementations/oauth2_auth.py

@@ -6,7 +6,8 @@
 
 
 class OAuth2Auth(Auth):
-    """Authentication using OAuth2 client credentials flow.
+    """REQUIRED
+    Authentication using OAuth2 client credentials flow.
 
     Implements the OAuth2 client credentials grant type for machine-to-machine
     authentication. The client automatically handles token acquisition and refresh.
@@ -27,10 +28,30 @@ class OAuth2Auth(Auth):
 
 
 class OAuth2AuthSerializer(Serializer[OAuth2Auth]):
+    """REQUIRED
+    Serializer for OAuth2Auth model."""
     def to_dict(self, obj: OAuth2Auth) -> dict:
+        """REQUIRED
+        Convert an OAuth2Auth object to a dictionary.
+
+        Args:
+            obj: The OAuth2Auth object to convert.
+
+        Returns:
+            The dictionary converted from the OAuth2Auth object.
+        """
         return obj.model_dump()
 
     def validate_dict(self, obj: dict) -> OAuth2Auth:
+        """REQUIRED
+        Validate a dictionary and convert it to an OAuth2Auth object.
+
+        Args:
+            obj: The dictionary to validate and convert.
+
+        Returns:
+            The OAuth2Auth object converted from the dictionary.
+        """
         try:
             return OAuth2Auth.model_validate(obj)
         except ValidationError as e:

core/src/utcp/data/call_template.py

@@ -29,7 +29,8 @@
 from utcp.data.auth import Auth, AuthSerializer
 
 class CallTemplate(BaseModel):
-    """Base class for all UTCP tool providers.
+    """REQUIRED
+    Base class for all UTCP tool providers.
 
     This is the abstract base class that all specific call template implementations
     inherit from. It provides the common fields that every provider must have.
@@ -61,12 +62,39 @@ def validate_auth(cls, v: Optional[Union[Auth, dict]]):
         return AuthSerializer().validate_dict(v)
 
 class CallTemplateSerializer(Serializer[CallTemplate]):
+    """REQUIRED
+    Serializer for call templates.
+
+    Defines the contract for serializers that convert call templates to and from
+    dictionaries for storage or transmission. Serializers are responsible for:
+    - Converting call templates to dictionaries for storage or transmission
+    - Converting dictionaries back to call templates
+    - Ensuring data consistency during serialization and deserialization
+    """
     call_template_serializers: dict[str, Serializer[CallTemplate]] = {}
 
     def to_dict(self, obj: CallTemplate) -> dict:
+        """REQUIRED
+        Convert a CallTemplate object to a dictionary.
+
+        Args:
+            obj: The CallTemplate object to convert.
+
+        Returns:
+            The dictionary converted from the CallTemplate object.
+        """
         return CallTemplateSerializer.call_template_serializers[obj.call_template_type].to_dict(obj)
 
     def validate_dict(self, obj: dict) -> CallTemplate:
+        """REQUIRED
+        Validate a dictionary and convert it to a CallTemplate object.
+
+        Args:
+            obj: The dictionary to validate and convert.
+
+        Returns:
+            The CallTemplate object converted from the dictionary.
+        """
         try:
             return CallTemplateSerializer.call_template_serializers[obj["call_template_type"]].validate_dict(obj)
         except KeyError:

core/src/utcp/data/register_manual_response.py

@@ -4,6 +4,15 @@
 from typing import List
 
 class RegisterManualResult(BaseModel):
+    """REQUIRED
+    Result of a manual registration.
+
+    Attributes:
+        manual_call_template: The call template of the registered manual.
+        manual: The registered manual.
+        success: Whether the registration was successful.
+        errors: List of error messages if registration failed.
+    """
     manual_call_template: CallTemplate
     manual: UtcpManual
     success: bool