# ExUtcp
[](https://hex.pm/packages/ex_utcp)
[](https://hex.pm/packages/ex_utcp)
[](https://hex.pm/packages/ex_utcp)
[](https://hexdocs.pm/ex_utcp)
Elixir implementation of the Universal Tool Calling Protocol (UTCP).
## 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. It is designed to be easy to use, interoperable, and extensible, making it a powerful choice for building and consuming tool-based services.
In contrast to other protocols like MCP, UTCP places a strong emphasis on:
* **Scalability**: UTCP is designed to handle a large number of tools and providers without compromising performance.
* **Interoperability**: With support for a wide range of provider types (including HTTP, WebSockets, gRPC, and even CLI tools), UTCP can integrate with almost any existing service or infrastructure.
* **Ease of Use**: The protocol is built on simple, intuitive patterns.
## Features
* Built-in transports for HTTP, CLI, Server-Sent Events, streaming HTTP, GraphQL, MCP, WebSocket, gRPC, TCP, UDP, and WebRTC
* Variable substitution via environment variables or `.env` files
* In-memory repository for storing providers and tools discovered at runtime
* Utilities such as `OpenApiConverter` to convert OpenAPI definitions into UTCP manuals
* Example programs demonstrating the client usage
## Installation
Add `ex_utcp` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ex_utcp, "~> 0.2.0"}
]
end
```
## Getting Started
### Basic Usage
```elixir
alias ExUtcp.{Client, Config}
# Create a client configuration
config = Config.new(providers_file_path: "providers.json")
# Start a UTCP client
{:ok, client} = Client.start_link(config)
# Search for tools
{:ok, tools} = Client.search_tools(client, "", 10)
# Call a tool
{:ok, result} = Client.call_tool(client, "provider.tool_name", %{"arg" => "value"})
```
### Programmatic Provider Registration
```elixir
alias ExUtcp.{Client, Config, Providers}
# Create a client
config = Config.new()
{:ok, client} = Client.start_link(config)
# Create an HTTP provider
provider = Providers.new_http_provider([
name: "my_api",
url: "https://api.example.com/tools",
http_method: "POST"
])
# Register the provider
{:ok, tools} = Client.register_tool_provider(client, provider)
# Call a discovered tool
{:ok, result} = Client.call_tool(client, "my_api.echo", %{"message" => "Hello!"})
```
### CLI Provider Example
```elixir
alias ExUtcp.{Client, Config, Providers}
# Create a client
config = Config.new()
{:ok, client} = Client.start_link(config)
# Create a CLI provider
provider = Providers.new_cli_provider([
name: "my_script",
command_name: "python my_script.py",
working_dir: "/path/to/script"
])
# Register the provider
{:ok, tools} = Client.register_tool_provider(client, provider)
# Call a tool
{:ok, result} = Client.call_tool(client, "my_script.greet", %{"name" => "World"})
```
## Configuration
### Provider Configuration File
Create a `providers.json` file to define your providers:
```json
{
"providers": [
{
"name": "http_api",
"type": "http",
"http_method": "POST",
"url": "https://api.example.com/tools",
"content_type": "application/json",
"headers": {
"User-Agent": "ExUtcp/0.2.0"
},
"auth": {
"type": "api_key",
"api_key": "${API_KEY}",
"location": "header",
"var_name": "Authorization"
}
},
{
"name": "cli_tool",
"type": "cli",
"command_name": "python my_tool.py",
"working_dir": "/opt/tools",
"env_vars": {
"PYTHONPATH": "/opt/tools"
}
}
]
}
```
### Variable Substitution
UTCP supports variable substitution using `${VAR}` or `$VAR` syntax:
```elixir
# Load variables from .env file
{:ok, env_vars} = Config.load_from_env_file(".env")
config = Config.new(
variables: env_vars,
providers_file_path: "providers.json"
)
```
## Architecture
The library is organized into several main components:
* ExUtcp.Client - Main client interface
* ExUtcp.Config - Configuration management
* ExUtcp.Providers - Provider implementations for different protocols
* ExUtcp.Transports - Transport layer implementations
* ExUtcp.Tools - Tool definitions and management
* ExUtcp.Repository - Tool and provider storage
## Implementation Status
### Gap Analysis: Elixir UTCP vs Go UTCP
| Feature Category | Go Implementation | Elixir Implementation | Coverage |
|------------------|-------------------|----------------------|----------|
| Core Client | Complete | Complete | 100% |
| Configuration | Complete | Enhanced | 85% |
| Transports | 12 types | 5 types | 42% |
| Providers | 12 types | 5 types | 42% |
| Authentication | 3 types | 3 types | 100% |
| Tool Management | Complete | Complete | 100% |
| Streaming | Complete | Production Ready | 100% |
| Search | Advanced | Enhanced | 75% |
| Performance | Optimized | Production Ready | 95% |
| Error Handling | Robust | Production Ready | 100% |
### Priority Recommendations
#### High Priority (Core Functionality)
- [x] Implement Missing Transports: WebSocket, gRPC, GraphQL
- [x] Add Streaming Support: Complete `CallToolStream` implementation
- [ ] Implement MCP Transport: Model Context Protocol integration
- [ ] OpenAPI Converter: Automatic API discovery
- [ ] Advanced Search: Implement sophisticated search algorithms
#### Medium Priority (Enhanced Features)
- [x] Performance Optimizations: Caching, connection pooling
- [x] Error Resilience: Retry logic, circuit breakers
- [ ] Monitoring: Metrics and health checks
- [ ] Batch Operations: Multiple tool calls
- [ ] Advanced Configuration: Per-transport settings
#### Low Priority (Nice to Have)
- [ ] WebRTC Support: Peer-to-peer communication
- [ ] TCP/UDP Support: Low-level network protocols
- [ ] Custom Variable Loaders: Beyond .env files
- [ ] Documentation: API documentation generation
### Current Implementation Status
#### Major Achievements
- **5 Production-Ready Transports**: HTTP, CLI, WebSocket, gRPC, and GraphQL
- **100% Streaming Support**: Complete real-time data streaming across all transports
- **100% Error Handling**: Robust error recovery with retry logic and circuit breakers
- **100% Authentication**: Full support for API Key, Basic, and OAuth2 across all transports
- **Advanced Connection Management**: Pooling, lifecycle management, and health monitoring
- **Comprehensive Testing**: 100+ tests covering all functionality
- **Production Examples**: Complete working examples for all transports
#### Completed Features
- HTTP Transport: Full REST API integration with OpenAPI support
- CLI Transport: Command-line tool integration with argument formatting
- WebSocket Transport: Production-ready real-time communication with WebSockex
- gRPC Transport: Production-ready high-performance RPC calls with Protocol Buffers
- GraphQL Transport: Production-ready GraphQL integration with HTTP/HTTPS support
- Core Client: GenServer-based client with full API compatibility
- Configuration Management: Variable substitution, environment loading
- Tool Management: Discovery, registration, search, and execution
- Authentication: API key, Basic, and OAuth2 support
- Repository Pattern: In-memory storage for providers and tools
- WebSocket Connection Management: Pooling, lifecycle, and error recovery
- WebSocket Performance: Connection reuse, message batching, retry logic
- WebSocket Testing: Comprehensive mock-based test suite
- gRPC Connection Management: Advanced pooling and lifecycle management
- gRPC Authentication: Full support for API Key, Basic, and OAuth2
- gRPC Error Recovery: Retry logic with exponential backoff
- gNMI Integration: Complete network management protocol support
- Protocol Buffer Integration: Full gRPC service definition support
- gRPC Testing: Comprehensive test suite with 82 tests
- GraphQL Connection Management: Advanced pooling and lifecycle management
- GraphQL Authentication: Full support for API Key, Basic, and OAuth2
- GraphQL Error Recovery: Retry logic with exponential backoff
- GraphQL Schema Introspection: Automatic tool discovery from GraphQL schemas
- GraphQL Streaming: Real-time data streaming via subscriptions
- GraphQL Testing: Comprehensive test suite with 18 tests
#### In Progress
- MCP Transport: Model Context Protocol integration
#### Planned
- Advanced Search: Sophisticated search algorithms
### Roadmap
#### Phase 1: Complete Core Transports (Current)
- [x] HTTP/HTTPS Transport
- [x] CLI Transport
- [x] WebSocket Transport
- [x] gRPC Transport
- [x] GraphQL Transport
- [ ] MCP Transport (In Progress)
#### Phase 2: Enhanced Features
- [ ] Advanced Search Algorithms
- [ ] OpenAPI Converter
- [ ] Monitoring and Metrics
- [ ] Batch Operations
#### Phase 3: Extended Protocol Support
- [ ] TCP/UDP Transport
- [ ] WebRTC Transport
- [ ] Server-Sent Events
- [ ] Streamable HTTP
#### Phase 4: Enterprise Features
- [ ] Advanced Configuration Management
- [ ] Custom Variable Loaders
- [ ] API Documentation Generation
- [ ] Performance Profiling
## Supported Transports
### Implemented
- HTTP/HTTPS: REST API integration with OpenAPI support
- CLI: Command-line tool integration
- WebSocket: Real-time communication (production-ready)
- gRPC: High-performance RPC calls with Protocol Buffers (production-ready)
- GraphQL: GraphQL API integration with HTTP/HTTPS (production-ready)
### In Progress
- MCP: Model Context Protocol integration
### Planned
- TCP/UDP: Low-level network protocols
- WebRTC: Peer-to-peer communication
- Server-Sent Events: Real-time streaming
- Streamable HTTP: HTTP streaming support
## Examples
Check the `examples/` directory for complete working examples:
- `http_client.exs` - HTTP provider example
- `cli_client.exs` - CLI provider example
- `websocket_client.exs` - WebSocket provider example
- `websocket_server.exs` - WebSocket server for testing
- `grpc_client.exs` - gRPC provider example
- `grpc_production_example.exs` - Production-ready gRPC with gNMI
- `graphql_example.exs` - GraphQL provider example with queries, mutations, and subscriptions
- `simple_example.exs` - Basic usage demonstration
## Testing
Run the test suite:
```bash
mix test
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MPL-2.0 License - see the [LICENSE](LICENSE) file for details.
## Links
- [UTCP Website](https://www.utcp.io/)
- [Go Implementation](https://github.com/universal-tool-calling-protocol/go-utcp)
- [Hex Package](https://hex.pm/packages/ex_utcp)
