Skip to content

Commit d0d49f7

Browse files
h3xxith3xxit
committed
Revert "Auto-translate README and Wiki" because of license change
This reverts commit 279919a.
1 parent ff20594 commit d0d49f7

File tree

1 file changed

+116
-147
lines changed

1 file changed

+116
-147
lines changed

‎README.md‎

Lines changed: 116 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -1,148 +1,117 @@
1+
# Universal Tool Calling Protocol (UTCP) Specification
12

2-
<div align="right">
3-
<details>
4-
<summary >🌐 Language</summary>
5-
<div>
6-
<div align="center">
7-
<a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=en">English</a>
8-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=zh-CN">简体中文</a>
9-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=zh-TW">繁體中文</a>
10-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=ja">日本語</a>
11-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=ko">한국어</a>
12-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=hi">हिन्दी</a>
13-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=th">ไทย</a>
14-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=fr">Français</a>
15-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=de">Deutsch</a>
16-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=es">Español</a>
17-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=it">Italiano</a>
18-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=ru">Русский</a>
19-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=pt">Português</a>
20-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=nl">Nederlands</a>
21-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=pl">Polski</a>
22-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=ar">العربية</a>
23-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=fa">فارسی</a>
24-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=tr">Türkçe</a>
25-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=vi">Tiếng Việt</a>
26-
| <a href="https://openaitx.github.io/view.html?user=universal-tool-calling-protocol&project=utcp-specification&lang=id">Bahasa Indonesia</a>
27-
</div>
28-
</div>
29-
</details>
30-
</div>
31-
32-
# Universal Tool Calling Protocol (UTCP) Specification
33-
34-
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.
35-
36-
## What is UTCP?
37-
38-
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:
39-
40-
- Tool discovery mechanisms
41-
- Tool call formats
42-
- Provider configuration
43-
- Authentication methods
44-
- Response handling
45-
46-
## Contributing to the Specification
47-
48-
We welcome contributions to the UTCP specification! Here's how you can contribute:
49-
50-
1. **Fork the repository**: Create your own fork of the specification repository
51-
2. **Make your changes**: Update or add documentation as needed
52-
3. **Submit a pull request**: Open a PR with your changes for review
53-
4. **Participate in discussions**: Join the conversation about proposed changes
54-
55-
When contributing, please follow these guidelines:
56-
57-
- Ensure your changes align with the overall vision and goals of UTCP
58-
- Follow the established documentation structure and formatting
59-
- Include examples when adding new features or concepts
60-
- Update relevant sections to maintain consistency across the documentation
61-
62-
## Building the Documentation Locally
63-
64-
### Prerequisites
65-
66-
To build and preview the documentation site locally, you'll need:
67-
68-
- Ruby version 2.5.0 or higher
69-
- RubyGems
70-
- Bundler
71-
72-
### Setup
73-
74-
1. Clone the repository:
75-
```bash
76-
git clone https://github.com/universal-tool-calling-protocol/utcp-specification.git
77-
cd utcp-specification
78-
```
79-
80-
2. Install dependencies:
81-
```bash
82-
bundle install
83-
```
84-
85-
### Running the Documentation Site
86-
87-
To build and serve the site locally:
88-
89-
```bash
90-
bundle exec jekyll serve
91-
```
92-
93-
This will start a local web server at `http://localhost:4000` where you can preview the documentation.
94-
95-
## Documentation Structure
96-
97-
The UTCP documentation is organized as follows:
98-
99-
- `index.md`: Homepage and introduction to UTCP
100-
- `docs/`
101-
- `introduction.md`: Detailed introduction and core concepts
102-
- `for-tool-providers.md`: Guide for implementing tool providers
103-
- `for-tool-callers.md`: Guide for implementing tool callers
104-
- `providers/`: Documentation for each provider type
105-
- `http.md`: HTTP provider
106-
- `websocket.md`: WebSocket provider
107-
- `cli.md`: CLI provider
108-
- `sse.md`: Server-Sent Events provider
109-
- etc.
110-
- `implementation.md`: Implementation guidelines and best practices
111-
112-
## Working with the Specification
113-
114-
### Modifying the Documentation
115-
116-
The documentation is written in Markdown format with Jekyll front matter. When making changes:
117-
118-
1. Ensure your Markdown follows the established style
119-
2. Preview changes locally before submitting PRs
120-
3. Keep examples up-to-date with the latest specification
121-
4. Update navigation items in `_config.yml` if adding new pages
122-
123-
### File Organization
124-
125-
When adding new documentation:
126-
127-
- Place provider-specific documentation in `docs/providers/`
128-
- Use consistent front matter with appropriate navigation ordering
129-
- Include tags for improved searchability on GitHub Pages
130-
131-
## Version Control
132-
133-
The UTCP specification follows semantic versioning:
134-
135-
- Major versions (1.0, 2.0): Breaking changes to the protocol
136-
- Minor versions (1.1, 1.2): New features added in a backward-compatible manner
137-
- Patch versions (1.0.1, 1.0.2): Backward-compatible bug fixes and clarifications
138-
139-
## License
140-
141-
This specification is distributed under the Mozilla Public License 2.0 (MPL-2.0).
142-
143-
## Additional Resources
144-
145-
- [UTCP GitHub Organization](https://github.com/universal-tool-calling-protocol)
146-
- [UTCP Website](https://utcp.io)
147-
- [Reference Implementations](https://github.com/universal-tool-calling-protocol/python-utcp)
148-
- [Community Discussions](https://github.com/universal-tool-calling-protocol/utcp-specification/discussions)
3+
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.
4+
5+
## What is UTCP?
6+
7+
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:
8+
9+
- Tool discovery mechanisms
10+
- Tool call formats
11+
- Provider configuration
12+
- Authentication methods
13+
- Response handling
14+
15+
## Contributing to the Specification
16+
17+
We welcome contributions to the UTCP specification! Here's how you can contribute:
18+
19+
1. **Fork the repository**: Create your own fork of the specification repository
20+
2. **Make your changes**: Update or add documentation as needed
21+
3. **Submit a pull request**: Open a PR with your changes for review
22+
4. **Participate in discussions**: Join the conversation about proposed changes
23+
24+
When contributing, please follow these guidelines:
25+
26+
- Ensure your changes align with the overall vision and goals of UTCP
27+
- Follow the established documentation structure and formatting
28+
- Include examples when adding new features or concepts
29+
- Update relevant sections to maintain consistency across the documentation
30+
31+
## Building the Documentation Locally
32+
33+
### Prerequisites
34+
35+
To build and preview the documentation site locally, you'll need:
36+
37+
- Ruby version 2.5.0 or higher
38+
- RubyGems
39+
- Bundler
40+
41+
### Setup
42+
43+
1. Clone the repository:
44+
```bash
45+
git clone https://github.com/universal-tool-calling-protocol/utcp-specification.git
46+
cd utcp-specification
47+
```
48+
49+
2. Install dependencies:
50+
```bash
51+
bundle install
52+
```
53+
54+
### Running the Documentation Site
55+
56+
To build and serve the site locally:
57+
58+
```bash
59+
bundle exec jekyll serve
60+
```
61+
62+
This will start a local web server at `http://localhost:4000` where you can preview the documentation.
63+
64+
## Documentation Structure
65+
66+
The UTCP documentation is organized as follows:
67+
68+
- `index.md`: Homepage and introduction to UTCP
69+
- `docs/`
70+
- `introduction.md`: Detailed introduction and core concepts
71+
- `for-tool-providers.md`: Guide for implementing tool providers
72+
- `for-tool-callers.md`: Guide for implementing tool callers
73+
- `providers/`: Documentation for each provider type
74+
- `http.md`: HTTP provider
75+
- `websocket.md`: WebSocket provider
76+
- `cli.md`: CLI provider
77+
- `sse.md`: Server-Sent Events provider
78+
- etc.
79+
- `implementation.md`: Implementation guidelines and best practices
80+
81+
## Working with the Specification
82+
83+
### Modifying the Documentation
84+
85+
The documentation is written in Markdown format with Jekyll front matter. When making changes:
86+
87+
1. Ensure your Markdown follows the established style
88+
2. Preview changes locally before submitting PRs
89+
3. Keep examples up-to-date with the latest specification
90+
4. Update navigation items in `_config.yml` if adding new pages
91+
92+
### File Organization
93+
94+
When adding new documentation:
95+
96+
- Place provider-specific documentation in `docs/providers/`
97+
- Use consistent front matter with appropriate navigation ordering
98+
- Include tags for improved searchability on GitHub Pages
99+
100+
## Version Control
101+
102+
The UTCP specification follows semantic versioning:
103+
104+
- Major versions (1.0, 2.0): Breaking changes to the protocol
105+
- Minor versions (1.1, 1.2): New features added in a backward-compatible manner
106+
- Patch versions (1.0.1, 1.0.2): Backward-compatible bug fixes and clarifications
107+
108+
## License
109+
110+
This specification is distributed under the Mozilla Public License 2.0 (MPL-2.0).
111+
112+
## Additional Resources
113+
114+
- [UTCP GitHub Organization](https://github.com/universal-tool-calling-protocol)
115+
- [UTCP Website](https://utcp.io)
116+
- [Reference Implementations](https://github.com/universal-tool-calling-protocol/python-utcp)
117+
- [Community Discussions](https://github.com/universal-tool-calling-protocol/utcp-specification/discussions)

0 commit comments

Comments
 (0)