Skip to main content
Version: Next

UTCP API Reference

API specification of a UTCP-compliant client implementation. Any implementation of a UTCP Client needs to have all of the classes, functions and fields described in this specification.

This specification is organized by module of the reference python implementation to provide a comprehensive understanding of UTCP's architecture.

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

Core Modules​

Core UTCP framework components that define the fundamental interfaces and implementations.

utcp.data.auth​

  • Contains: 2 classes, 2 methods

utcp.data.auth_implementations.api_key_auth​

  • Contains: 2 classes, 2 methods

utcp.data.auth_implementations.basic_auth​

  • Contains: 2 classes, 2 methods

utcp.data.auth_implementations.oauth2_auth​

  • Contains: 2 classes, 2 methods

utcp.data.call_template​

  • Contains: 2 classes, 2 methods

utcp.data.register_manual_response​

  • Contains: 1 classes

utcp.data.tool​

  • Contains: 4 classes, 4 methods

utcp.data.utcp_client_config​

  • Contains: 2 classes, 2 methods

utcp.data.utcp_manual​

  • Contains: 2 classes, 2 methods

utcp.data.variable_loader​

  • Contains: 2 classes, 3 methods

utcp.data.variable_loader_implementations.dot_env_variable_loader​

  • Contains: 2 classes, 3 methods

utcp.exceptions.utcp_serializer_validation_error​

  • Contains: 1 classes

utcp.exceptions.utcp_variable_not_found_exception​

  • Contains: 1 classes, 1 methods

utcp.implementations.default_variable_substitutor​

  • Contains: 1 classes, 2 methods

utcp.implementations.in_mem_tool_repository​

  • Contains: 2 classes, 12 methods

utcp.implementations.post_processors.filter_dict_post_processor​

  • Contains: 2 classes

utcp.implementations.post_processors.limit_strings_post_processor​

  • Contains: 2 classes
  • Contains: 2 classes, 3 methods

utcp.implementations.utcp_client_implementation​

  • Contains: 1 classes, 9 methods

utcp.interfaces.communication_protocol​

  • Contains: 1 classes, 4 methods

utcp.interfaces.concurrent_tool_repository​

  • Contains: 1 classes, 10 methods

utcp.interfaces.serializer​

  • Contains: 1 classes, 3 methods

utcp.interfaces.tool_post_processor​

  • Contains: 2 classes, 3 methods

utcp.interfaces.tool_search_strategy​

  • Contains: 2 classes, 3 methods

utcp.interfaces.variable_substitutor​

  • Contains: 1 classes, 2 methods

utcp.plugins.discovery​

  • Contains: 7 functions

utcp.plugins.plugin_loader​

  • Contains: 2 functions

utcp.utcp_client​

  • Contains: 1 classes, 9 methods

Plugin Modules​

Plugin implementations that extend UTCP with specific transport protocols and capabilities.

communication_protocols.cli.src.utcp_cli.cli_call_template​

  • Contains: 3 classes, 2 methods

communication_protocols.cli.src.utcp_cli.cli_communication_protocol​

  • Contains: 1 classes, 4 methods

communication_protocols.http.src.utcp_http.http_call_template​

  • Contains: 2 classes, 2 methods

communication_protocols.http.src.utcp_http.http_communication_protocol​

  • Contains: 1 classes, 4 methods

communication_protocols.http.src.utcp_http.openapi_converter​

  • Contains: 1 classes, 1 methods

communication_protocols.http.src.utcp_http.sse_call_template​

  • Contains: 2 classes, 2 methods

communication_protocols.http.src.utcp_http.sse_communication_protocol​

  • Contains: 1 classes, 4 methods

communication_protocols.http.src.utcp_http.streamable_http_call_template​

  • Contains: 2 classes, 2 methods

communication_protocols.http.src.utcp_http.streamable_http_communication_protocol​

  • Contains: 1 classes, 4 methods

communication_protocols.mcp.src.utcp_mcp.mcp_call_template​

  • Contains: 3 classes, 2 methods

communication_protocols.mcp.src.utcp_mcp.mcp_communication_protocol​

  • Contains: 1 classes, 3 methods

communication_protocols.text.src.utcp_text.text_call_template​

  • Contains: 2 classes, 2 methods

communication_protocols.text.src.utcp_text.text_communication_protocol​

  • Contains: 1 classes, 4 methods

About UTCP​

The Universal Tool Calling Protocol (UTCP) is a framework for calling tools across various transport protocols. This API reference covers all the essential interfaces, implementations, and extension points needed to:

  • Implement new transport protocols
  • Extend UTCP with custom functionality
  • Integrate UTCP into your applications
  • Understand the complete UTCP architecture