This repository contains the official specification documentation for the Universal Tool Calling Protocol (UTCP). UTCP is a modern, flexible, and scalable standard for defining and interacting with tools across various communication protocols.
UTCP provides a standardized way for AI systems and other clients to discover and call tools from different providers, regardless of the underlying protocol used (HTTP, WebSocket, CLI, etc.). This specification defines:
- Tool discovery mechanisms
- Tool call formats and templates
- Plugin-based architecture for extensibility
- Enhanced authentication methods
- Comprehensive error handling
- Response processing and validation
UTCP v1.0 introduces significant architectural improvements:
- Plugin Architecture: Core functionality split into pluggable components for better modularity
- Enhanced Data Models: Improved Pydantic models with comprehensive validation
- Multiple Protocol Support: HTTP, CLI, WebSocket, Text, and MCP protocols via plugins
- Advanced Authentication: Expanded authentication options including API key, OAuth, and custom auth
- Better Error Handling: Specific exception types for different error scenarios
- Performance Optimizations: Optimized client and protocol implementations
- Async/Await Support: Full asynchronous client interface for better performance
We welcome contributions to the UTCP specification! Here's how you can contribute:
- Fork the repository: Create your own fork of the specification repository
- Make your changes: Update or add documentation as needed
- Submit a pull request: Open a PR with your changes for review
- Participate in discussions: Join the conversation about proposed changes
When contributing, please follow these guidelines:
- Ensure your changes align with the overall vision and goals of UTCP
- Follow the established documentation structure and formatting
- Include examples when adding new features or concepts
- Update relevant sections to maintain consistency across the documentation
# Install the core UTCP package
pip install utcp
# Install protocol plugins as needed
pip install utcp-http utcp-cli utcp-websocket utcp-text utcp-mcpIf you're upgrading from UTCP v0.1, please see our comprehensive Migration Guide which covers:
- Breaking changes and architectural improvements
- Step-by-step migration instructions
- Configuration and manual format updates
- Common migration issues and solutions
To build and preview the documentation site locally, you'll need:
- Node.js version 18.0 or higher
- npm or yarn package manager
-
Clone the repository:
git clone https://github.com/universal-tool-calling-protocol/utcp-specification.git cd utcp-specification -
Install dependencies:
npm install
To build and serve the site locally:
npm startThis will start a local development server at http://localhost:3000 where you can preview the documentation.
The UTCP documentation is organized as follows:
docs/index.md: Homepage and introduction to UTCPintroduction.md: Detailed introduction and core conceptsfor-tool-providers.md: Guide for implementing tool providersfor-tool-callers.md: Guide for implementing tool callersmigration-v0.1-to-v1.0.md: Comprehensive migration guide from v0.1 to v1.0protocols/: Documentation for each protocol typehttp.md: HTTP protocol implementationwebsocket.md: WebSocket protocol implementationcli.md: CLI protocol implementationsse.md: Server-Sent Events protocol implementationtext.md: Text protocol implementationmcp.md: Model Context Protocol implementation
api/: API reference documentationcore/: Core API documentationplugins/: Plugin API documentation
implementation.md: Implementation guidelines and best practices
versioned_docs/: Version-specific documentation for backwards compatibility
The documentation is built with Docusaurus and written in Markdown format. When making changes:
- Ensure your Markdown follows the established style
- Preview changes locally before submitting PRs
- Keep examples up-to-date with the latest specification (v1.0)
- Update navigation items in
sidebars.tsif adding new pages - Consider version compatibility when making breaking changes
When adding new documentation:
- Place protocol-specific documentation in
docs/protocols/ - Place API documentation in
docs/api/core/ordocs/api/plugins/ - Use consistent front matter with appropriate navigation ordering
- Include tags for improved searchability
- Consider versioning for breaking changes using
versioned_docs/
The UTCP specification follows semantic versioning:
- Major versions (1.0, 2.0): Breaking changes to the protocol
- Minor versions (1.1, 1.2): New features added in a backward-compatible manner
- Patch versions (1.0.1, 1.0.2): Backward-compatible bug fixes and clarifications
This repository is dual-licensed by directory to keep adoption friction low while respecting the upstream license of the reference implementation:
- Default license — Apache License 2.0. Covers everything
in the repository except the
api/documentation subtrees: the specification prose, protocol guides, RFC, blog posts, code examples (whether standalone files or fenced code blocks in Markdown), site source code, and build configuration. Implementers can quote, copy, and embed this content freely under Apache-2.0 terms. - API reference docs — Mozilla Public License 2.0. The
contents of
docs/api/**andversioned_docs/version-*/api/**are auto-generated from docstrings in python-utcp, which is MPL-2.0-licensed. External contributors submit docstring changes under MPL-2.0, so the generated reference docs inherit that license. Each MPL-covered subtree contains its ownLICENSEandNOTICE.md.
The MPL-2.0 boundary is the api/ directory — not a "code vs. prose"
distinction. SPDX: Apache-2.0 AND MPL-2.0.