Docs version 1.1

Author: h3xxit

docs/api/core/utcp/data/call_template.md

@@ -24,13 +24,19 @@ inherit from. It provides the common fields that every provider must have.
   Should be unique across all providers and recommended to be set to a human-readable name.
   Can only contain letters, numbers and underscores. All special characters must be replaced with underscores.
 - **`call_template_type`**: The transport protocol type used by this provider.
+- **`allowed_communication_protocols`**: Optional list of communication protocol types that tools
+  registered under this manual are allowed to use. If None or empty, defaults to only allowing
+  the same protocol type as the manual's call_template_type. This provides fine-grained security
+  control - e.g., set to ["http", "cli"] to allow both HTTP and CLI tools, or leave unset to
+  restrict tools to the manual's own protocol type.
 </details>
 
 #### Fields:
 
 - name: str
 - call_template_type: str
 - auth: Optional[[Auth](./auth.md#auth)]
+- allowed_communication_protocols: Optional[List[str]]
 
 ---
 

docs/api/core/utcp/implementations/default_variable_substitutor.md

@@ -52,6 +52,13 @@ Non-string types are returned unchanged. String values are scanned
 for variable references using $\{VAR\} and $VAR syntax.
 
 
+**Note**
+
+Strings containing '$ref' are skipped to support OpenAPI specs
+stored as string content, where $ref is a JSON reference keyword.
+
+
+
 **Args**
 
 - **`obj`**: Object to perform substitution on. Can be any type.
@@ -97,6 +104,13 @@ returning fully-qualified variable names with variable namespacing.
 Useful for validation and dependency analysis.
 
 
+**Note**
+
+Strings containing '$ref' are skipped to support OpenAPI specs
+stored as string content, where $ref is a JSON reference keyword.
+
+
+
 **Args**
 
 - **`obj`**: Object to scan for variable references.
@@ -113,7 +127,7 @@ Useful for validation and dependency analysis.
 
 **Returns**
 
-List of fully-qualified variable names found in the object.
+List of unique fully-qualified variable names found in the object.
 
 
 

docs/api/core/utcp/implementations/utcp_client_implementation.md

@@ -36,6 +36,20 @@ A new `[UtcpClient](./../utcp_client.md#utcpclient)` instance.
 
 Register a manual in the client.
 
+Registers a manual and its tools with the client. During registration, tools are
+
+**Filtered Based On The Manual'S `Allowed_Communication_Protocols` Setting**
+
+
+- If `allowed_communication_protocols` is set to a non-empty list, only tools using
+protocols in that list are registered.
+- If `allowed_communication_protocols` is None or empty, it defaults to only allowing
+the manual's own `call_template_type`. This provides secure-by-default behavior.
+
+Tools that don't match the allowed protocols are excluded from registration and a
+warning is logged for each excluded tool.
+
+
 
 **Args**
 
@@ -45,7 +59,14 @@ Register a manual in the client.
 
 **Returns**
 
-A `[RegisterManualResult](./../data/register_manual_response.md#registermanualresult)` instance representing the result of the registration.
+A `[RegisterManualResult](./../data/register_manual_response.md#registermanualresult)` instance containing the registered tools (filtered by
+allowed protocols) and any errors encountered.
+
+
+
+**Raises**
+
+- **`ValueError`**: If manual name is already registered or communication protocol is not found.
 </details>
 
 <details>
@@ -87,35 +108,73 @@ A boolean indicating whether the manual was successfully deregistered.
 
 Call a tool in the client.
 
+Executes a registered tool with the provided arguments. Before execution, validates
+that the tool's communication protocol is allowed by the parent manual's
+
+**`Allowed_Communication_Protocols` Setting**
+
+
+- If `allowed_communication_protocols` is set to a non-empty list, the tool's protocol
+must be in that list.
+- If `allowed_communication_protocols` is None or empty, only tools using the manual's
+own `call_template_type` are allowed.
+
+
 
 **Args**
 
-- **`tool_name`**: The name of the tool to call.
+- **`tool_name`**: The fully qualified name of the tool (e.g., "manual_name.tool_name").
 - **`tool_args`**: A dictionary of arguments to pass to the tool.
 
 
 
 **Returns**
 
-The result of the tool call.
+The result of the tool call, after any post-processing.
+
+
+
+**Raises**
+
+- **`ValueError`**: If the tool is not found or if the tool's communication protocol
+  is not in the manual's allowed protocols.
 </details>
 
 <details>
 <summary>async call_tool_streaming(self, tool_name: str, tool_args: Dict[str, Any]) -> AsyncGenerator[Any, None]</summary>
 
-Call a tool in the client streamingly.
+Call a tool in the client with streaming response.
+
+Executes a registered tool with streaming output. Before execution, validates
+that the tool's communication protocol is allowed by the parent manual's
+
+**`Allowed_Communication_Protocols` Setting**
+
+
+- If `allowed_communication_protocols` is set to a non-empty list, the tool's protocol
+must be in that list.
+- If `allowed_communication_protocols` is None or empty, only tools using the manual's
+own `call_template_type` are allowed.
+
 
 
 **Args**
 
-- **`tool_name`**: The name of the tool to call.
+- **`tool_name`**: The fully qualified name of the tool (e.g., "manual_name.tool_name").
 - **`tool_args`**: A dictionary of arguments to pass to the tool.
 
 
 
-**Returns**
+**Yields**
+
+Chunks of the tool's streaming response, after any post-processing.
+
+
+
+**Raises**
 
-An async generator yielding the result of the tool call.
+- **`ValueError`**: If the tool is not found or if the tool's communication protocol
+  is not in the manual's allowed protocols.
 </details>
 
 <details>

docs/api/index.md

@@ -11,8 +11,8 @@ This specification is organized by module of the reference python implementation
 
 **Note:** The modules don't have to be implemented in the same way as in the reference implementation, but all of the functionality here needs to be provided.
 
-**Total documented items:** 195
-**Modules documented:** 41
+**Total documented items:** 211
+**Modules documented:** 45
 
 ## Core Modules
 
@@ -172,6 +172,16 @@ Plugin implementations that extend UTCP with specific transport protocols and ca
 - **Contains:** 1 classes, 4 methods
 
 
+### [communication_protocols.file.src.utcp_file.file_call_template](./plugins\communication_protocols\file\src\utcp_file\file_call_template.md)
+
+- **Contains:** 2 classes, 2 methods
+
+
+### [communication_protocols.file.src.utcp_file.file_communication_protocol](./plugins\communication_protocols\file\src\utcp_file\file_communication_protocol.md)
+
+- **Contains:** 1 classes, 4 methods
+
+
 ### [communication_protocols.http.src.utcp_http.http_call_template](./plugins\communication_protocols\http\src\utcp_http\http_call_template.md)
 
 - **Contains:** 2 classes, 2 methods
@@ -227,6 +237,16 @@ Plugin implementations that extend UTCP with specific transport protocols and ca
 - **Contains:** 1 classes, 4 methods
 
 
+### [communication_protocols.websocket.src.utcp_websocket.websocket_call_template](./plugins\communication_protocols\websocket\src\utcp_websocket\websocket_call_template.md)
+
+- **Contains:** 2 classes
+
+
+### [communication_protocols.websocket.src.utcp_websocket.websocket_communication_protocol](./plugins\communication_protocols\websocket\src\utcp_websocket\websocket_communication_protocol.md)
+
+- **Contains:** 1 classes, 4 methods
+
+
 ## About UTCP
 
 The Universal Tool Calling Protocol (UTCP) is a framework for calling tools across various transport protocols.

docs/api/plugins/communication_protocols/file/src/utcp_file/file_call_template.md

@@ -0,0 +1,57 @@
+---
+title: file_call_template
+sidebar_label: file_call_template
+---
+
+# file_call_template
+
+**File:** `plugins/communication_protocols/file/src/utcp_file/file_call_template.py`
+
+### class FileCallTemplate ([CallTemplate](./../../../../../core/utcp/data/call_template.md#calltemplate)) {#filecalltemplate}
+
+<details>
+<summary>Documentation</summary>
+
+Call template for file-based manuals and tools.
+
+Reads UTCP manuals or tool definitions from local JSON/YAML files. Useful for
+static tool configurations or environments where manuals are distributed as files.
+For direct text content, use the text protocol instead.
+
+
+**Attributes**
+
+- **`call_template_type`**: Always "file" for file call templates.
+- **`file_path`**: Path to the file containing the UTCP manual or tool definitions.
+- **`auth`**: Always None - file call templates don't support authentication for file access.
+- **`auth_tools`**: Optional authentication to apply to generated tools from OpenAPI specs.
+</details>
+
+#### Fields:
+
+- call_template_type: Literal['file']
+- file_path: str
+- auth: None
+- auth_tools: Optional[[Auth](./../../../../../core/utcp/data/auth.md#auth)]
+
+---
+
+### class FileCallTemplateSerializer ([Serializer](./../../../../../core/utcp/interfaces/serializer.md#serializer)[FileCallTemplate]) {#filecalltemplateserializer}
+
+*No class documentation available*
+
+#### Methods:
+
+<details>
+<summary>to_dict(self, obj: FileCallTemplate) -> dict</summary>
+
+*No method documentation available*
+</details>
+
+<details>
+<summary>validate_dict(self, obj: dict) -> FileCallTemplate</summary>
+
+*No method documentation available*
+</details>
+
+---

docs/api/plugins/communication_protocols/file/src/utcp_file/file_communication_protocol.md

@@ -0,0 +1,40 @@
+---
+title: file_communication_protocol
+sidebar_label: file_communication_protocol
+---
+
+# file_communication_protocol
+
+**File:** `plugins/communication_protocols/file/src/utcp_file/file_communication_protocol.py`
+
+### class FileCommunicationProtocol ([CommunicationProtocol](./../../../../../core/utcp/interfaces/communication_protocol.md#communicationprotocol)) {#filecommunicationprotocol}
+
+*No class documentation available*
+
+#### Methods:
+
+<details>
+<summary>async register_manual(self, caller: '[UtcpClient](./../../../../../core/utcp/utcp_client.md#utcpclient)', manual_call_template: [CallTemplate](./../../../../../core/utcp/data/call_template.md#calltemplate)) -> [RegisterManualResult](./../../../../../core/utcp/data/register_manual_response.md#registermanualresult)</summary>
+
+*No method documentation available*
+</details>
+
+<details>
+<summary>async deregister_manual(self, caller: '[UtcpClient](./../../../../../core/utcp/utcp_client.md#utcpclient)', manual_call_template: [CallTemplate](./../../../../../core/utcp/data/call_template.md#calltemplate)) -> None</summary>
+
+*No method documentation available*
+</details>
+
+<details>
+<summary>async call_tool(self, caller: '[UtcpClient](./../../../../../core/utcp/utcp_client.md#utcpclient)', tool_name: str, tool_args: Dict[str, Any], tool_call_template: [CallTemplate](./../../../../../core/utcp/data/call_template.md#calltemplate)) -> Any</summary>
+
+*No method documentation available*
+</details>
+
+<details>
+<summary>async call_tool_streaming(self, caller: '[UtcpClient](./../../../../../core/utcp/utcp_client.md#utcpclient)', tool_name: str, tool_args: Dict[str, Any], tool_call_template: [CallTemplate](./../../../../../core/utcp/data/call_template.md#calltemplate)) -> AsyncGenerator[Any, None]</summary>
+
+*No method documentation available*
+</details>
+
+---

docs/api/plugins/communication_protocols/http/src/utcp_http/http_call_template.md

@@ -48,6 +48,12 @@ URL body, headers or query pattern parameters are passed as query parameters usi
         "var_name": "Authorization",
         "location": "header"
       },
+      "auth_tools": {
+        "auth_type": "api_key",
+        "api_key": "Bearer ${TOOL_API_KEY}",
+        "var_name": "Authorization",
+        "location": "header"
+      },
       "headers": {
         "X-Custom-Header": "value"
       },
@@ -102,7 +108,8 @@ URL body, headers or query pattern parameters are passed as query parameters usi
 - **`url`**: The base URL for the HTTP endpoint. Supports path parameters like
   "https://api.example.com/users/{user_id}/posts/{post_id}".
 - **`content_type`**: The Content-Type header for requests.
-- **`auth`**: Optional authentication configuration.
+- **`auth`**: Optional authentication configuration for accessing the OpenAPI spec URL.
+- **`auth_tools`**: Optional authentication configuration for generated tools. Applied only to endpoints requiring auth per OpenAPI spec.
 - **`headers`**: Optional static headers to include in all requests.
 - **`body_field`**: Name of the tool argument to map to the HTTP request body.
 - **`header_fields`**: List of tool argument names to map to HTTP request headers.
@@ -115,6 +122,7 @@ URL body, headers or query pattern parameters are passed as query parameters usi
 - url: str
 - content_type: str
 - auth: Optional[[Auth](./../../../../../core/utcp/data/auth.md#auth)]
+- auth_tools: Optional[[Auth](./../../../../../core/utcp/data/auth.md#auth)]
 - headers: Optional[Dict[str, str]]
 - body_field: Optional[str]
 - header_fields: Optional[List[str]]

docs/api/plugins/communication_protocols/text/src/utcp_text/text_call_template.md

@@ -12,24 +12,30 @@ sidebar_label: text_call_template
 <details>
 <summary>Documentation</summary>
 
-Call template for text file-based manuals and tools.
+Text call template for UTCP client.
 
-Reads UTCP manuals or tool definitions from local JSON/YAML files. Useful for
-static tool configurations or environments where manuals are distributed as files.
+This template allows passing UTCP manuals or tool definitions directly as text content.
+It supports both JSON and YAML formats and can convert OpenAPI specifications to UTCP manuals.
+It's browser-compatible and requires no file system access.
+For file-based manuals, use the file protocol instead.
 
 
 **Attributes**
 
-- **`call_template_type`**: Always "text" for text file call templates.
-- **`file_path`**: Path to the file containing the UTCP manual or tool definitions.
+- **`call_template_type`**: Always "text" for text call templates.
+- **`content`**: Direct text content of the UTCP manual or tool definitions (required).
+- **`base_url`**: Optional base URL for API endpoints when converting OpenAPI specs.
 - **`auth`**: Always None - text call templates don't support authentication.
+- **`auth_tools`**: Optional authentication to apply to generated tools from OpenAPI specs.
 </details>
 
 #### Fields:
 
 - call_template_type: Literal['text']
-- file_path: str
+- content: str
+- base_url: Optional[str]
 - auth: None
+- auth_tools: Optional[[Auth](./../../../../../core/utcp/data/auth.md#auth)]
 
 ---