-
Notifications
You must be signed in to change notification settings - Fork 18
OpenAPI docs and fix a lot of issues (#47) #48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -28,6 +28,10 @@ UTCP acts as a **"manual"** that tells agents how to call your tools directly: | |||||
| *"If a human can call your API, an AI agent should be able to call it too - with the same security and no additional infrastructure."* | ||||||
| ::: | ||||||
|
|
||||||
| ## OpenAPI Compatibility | ||||||
|
|
||||||
| UTCP extends OpenAPI for AI agents while maintaining full backward compatibility. Where OpenAPI describes APIs for human developers, UTCP adds agent-focused enhancements: `tags` for categorization, `average_response_size` for resource planning, multi-protocol support (HTTP, CLI, gRPC, MCP), and direct execution instructions. Existing OpenAPI specs can be automatically converted to UTCP manuals without requiring API changes or additional infrastructure. | ||||||
|
|
||||||
| ## Quick Start (5 Minutes) | ||||||
|
|
||||||
| ### 1. Install UTCP | ||||||
|
|
@@ -44,7 +48,12 @@ npm install @utcp/core @utcp/http | |||||
|
|
||||||
| ### 2. Expose Your First Tool | ||||||
|
|
||||||
| Add a discovery endpoint to your existing API: | ||||||
| **Option A: Discovery via existing OpenAPI spec** | ||||||
|
|
||||||
| **Generate OpenAPI endpoint**: `GET http://api.github.com/openapi.json` | ||||||
|
|
||||||
|
|
||||||
| **Option B: Add a discovery endpoint to your existing API** | ||||||
|
|
||||||
| **Add endpoint**: `GET /utcp` | ||||||
| **Return your UTCP manual**: | ||||||
|
|
@@ -72,31 +81,55 @@ Add a discovery endpoint to your existing API: | |||||
| "var_name": "appid", | ||||||
| "location": "query" | ||||||
| } | ||||||
| } | ||||||
| }] | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| ### 3. Call Your Tool | ||||||
|
|
||||||
| **Configure UTCP client**: | ||||||
| **Option A: Configure UTCP client**: | ||||||
| ```json | ||||||
| { | ||||||
| "manual_call_templates": [{ | ||||||
| "name": "weather_api", | ||||||
| "call_template_type": "http", | ||||||
| "url": "http://localhost:8000/utcp", | ||||||
| "url": "http://localhost:8000/utcp", // Or http://api.github.com/openapi.json, the openapi spec gets converted automatically | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. JSON example includes a // comment, which is invalid JSON and will break copy-paste usage; move the note outside the code block or remove it. Prompt for AI agents
Suggested change
|
||||||
| "http_method": "GET" | ||||||
| }] | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| **Option B: Convert OpenAPI spec to UTCP manual manually** | ||||||
|
|
||||||
| ```python | ||||||
| async def convert_api(): | ||||||
| async with aiohttp.ClientSession() as session: | ||||||
| async with session.get("https://api.github.com/openapi.json") as response: | ||||||
| openapi_spec = await response.json() | ||||||
|
|
||||||
| converter = OpenApiConverter(openapi_spec) | ||||||
| manual = converter.convert() | ||||||
|
|
||||||
| print(f"Generated {len(manual.tools)} tools from GitHub API!") | ||||||
| return manual | ||||||
| ``` | ||||||
|
|
||||||
| Then save that to a text file and load it with the text configuration: | ||||||
| ```json | ||||||
| { | ||||||
| "manual_call_templates": [{ | ||||||
| "name": "github_manual", | ||||||
| "call_template_type": "text", | ||||||
| "file_path": "./github_manual.json", | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trailing comma makes this JSON invalid; remove the comma after the last property. Prompt for AI agents
Suggested change
|
||||||
| }] | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
|
|
||||||
| **Call the tool**: | ||||||
| 1. Initialize UTCP client with configuration | ||||||
| 2. Discover tools from weather API | ||||||
| 3. Call `get_weather` tool with location parameter | ||||||
| 4. Receive weather data response | ||||||
| ``` | ||||||
|
|
||||||
| **That's it!** Your tool is now discoverable and callable by any UTCP client. | ||||||
|
|
||||||
|
|
@@ -106,7 +139,7 @@ Add a discovery endpoint to your existing API: | |||||
| |---------|-------------| | ||||||
| | **🚀 Zero Latency Overhead** | Direct tool calls, no proxy servers | | ||||||
| | **🔒 Native Security** | Use your existing authentication and authorization | | ||||||
| | **🌐 Protocol Flexibility** | HTTP, WebSocket, CLI, GraphQL, and more | | ||||||
| | **🌐 Protocol Flexibility** | HTTP, MCP, CLI, GraphQL, and more | | ||||||
| | **⚡ Easy Integration** | Add one endpoint, no infrastructure changes | | ||||||
| | **📈 Scalable** | Leverage your existing scaling and monitoring | | ||||||
|
|
||||||
|
|
@@ -132,7 +165,6 @@ UTCP supports multiple communication protocols through plugins: | |||||
| | Protocol | Use Case | Plugin | Status | | ||||||
| |----------|----------|--------|--------| | ||||||
| | **[HTTP](./protocols/http.md)** | REST APIs, webhooks | `utcp-http` | ✅ Stable | | ||||||
| | **[WebSocket](./protocols/websocket.md)** | Real-time communication | `utcp-websocket` | ✅ Stable | | ||||||
| | **[CLI](./protocols/cli.md)** | Command-line tools | `utcp-cli` | ✅ Stable | | ||||||
| | **[Server-Sent Events](./protocols/streamable-http.md)** | Streaming data | `utcp-http` | ✅ Stable | | ||||||
| | **[Text Files](./protocols/text.md)** | File reading | `utcp-text` | ✅ Stable | | ||||||
|
|
@@ -151,7 +183,7 @@ UTCP v1.0 features a modular, plugin-based architecture: | |||||
| - **[UTCP Client](./api/core/utcp/utcp_client.md)**: Tool discovery and execution engine | ||||||
|
|
||||||
| ### Plugin System | ||||||
| - **Protocol Plugins**: HTTP, WebSocket, CLI, etc. | ||||||
| - **Protocol Plugins**: HTTP, MCP, CLI, etc. | ||||||
| - **Custom Protocols**: Extend with your own communication methods | ||||||
| - **Tool Repositories**: Pluggable storage for tool definitions | ||||||
| - **Search Strategies**: Customizable tool discovery algorithms | ||||||
|
|
||||||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use HTTPS for the GitHub OpenAPI endpoint to avoid redirects/failures and align with the later example.
Prompt for AI agents