Skip to content

Commit cd7a28f

Browse files
authored
Merge pull request #50 from perrozzi/cherry-pick-branch
docs: fix README inconsistencies and typos
2 parents c81496d + 8d7fbc0 commit cd7a28f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Version 1.0.0 introduces several breaking changes. Follow these steps to migrate
8787
3. **Update Imports**: Change your imports to reflect the new modular structure. For example, `from utcp.client.transport_interfaces.http_transport import HttpProvider` becomes `from utcp_http.http_call_template import HttpCallTemplate`.
8888
4. **Tool Search**: If you were using the default search, the new strategy is `TagAndDescriptionWordMatchStrategy`. This is the new default and requires no changes unless you were implementing a custom strategy.
8989
5. **Tool Naming**: Tool names are now namespaced as `manual_name.tool_name`. The client handles this automatically.
90-
6 **Variable Substitution Namespacing**: Variables that are subsituted in different `call_templates`, are first namespaced with the name of the manual with the `_` duplicated. So a key in a tool call template called `API_KEY` from the manual `manual_1` would be converted to `manual__1_API_KEY`.
90+
6. **Variable Substitution Namespacing**: Variables that are substituted in different `call_templates`, are first namespaced with the name of the manual with the `_` duplicated. So a key in a tool call template called `API_KEY` from the manual `manual_1` would be converted to `manual__1_API_KEY`.
9191

9292
## Usage Examples
9393

@@ -226,7 +226,7 @@ if __name__ == "__main__":
226226

227227
### 2. Providing a UTCP Manual
228228

229-
A `UTCPManual` describes the tools you offer. The key change is replacing `tool_provider` with `call_template`.
229+
A `UTCPManual` describes the tools you offer. The key change is replacing `tool_provider` with `tool_call_template`.
230230

231231
**`server.py`**
232232

@@ -288,7 +288,7 @@ def utcp_discovery():
288288
"conditions": {"type": "string"}
289289
}
290290
},
291-
"call_template": {
291+
"tool_call_template": {
292292
"call_template_type": "http",
293293
"url": "https://example.com/api/weather",
294294
"http_method": "GET"
@@ -311,7 +311,7 @@ You can find full examples in the [examples repository](https://github.com/unive
311311

312312
### `UtcpManual` and `Tool` Models
313313

314-
The `tool_provider` object inside a `Tool` has been replaced by `call_template`.
314+
The `tool_provider` object inside a `Tool` has been replaced by `tool_call_template`.
315315

316316
```json
317317
{
@@ -324,7 +324,7 @@ The `tool_provider` object inside a `Tool` has been replaced by `call_template`.
324324
"inputs": { ... },
325325
"outputs": { ... },
326326
"tags": ["string"],
327-
"call_template": {
327+
"tool_call_template": {
328328
"call_template_type": "http",
329329
"url": "https://...",
330330
"http_method": "GET"

0 commit comments

Comments
 (0)