Skip to content

Commit cc47da6

Browse files
committed
align naming convention with actaul support in Claude and OpenAI models
1 parent 0a727e5 commit cc47da6

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/docs/learn/architecture.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ Now that the connection is established, the client can discover available tools
256256
"result": {
257257
"tools": [
258258
{
259-
"name": "com.example.calculator/arithmetic",
259+
"name": "calculator_arithmetic",
260260
"title": "Calculator",
261261
"description": "Perform mathematical calculations including basic arithmetic, trigonometric functions, and algebraic operations",
262262
"inputSchema": {
@@ -271,7 +271,7 @@ Now that the connection is established, the client can discover available tools
271271
}
272272
},
273273
{
274-
"name": "com.example.weather/current",
274+
"name": "weather_current",
275275
"title": "Weather Information",
276276
"description": "Get current weather information for any location worldwide",
277277
"inputSchema": {
@@ -307,7 +307,7 @@ The response contains a `tools` array that provides comprehensive metadata about
307307

308308
Each tool object in the response includes several key fields:
309309

310-
- **`name`**: A unique identifier for the tool within the server's namespace. This serves as the primary key for tool execution and should be URI-like for better namespacing (e.g., `com.example.calculator/arithmetic` rather than just `calculate`)
310+
- **`name`**: A unique identifier for the tool within the server's namespace. This serves as the primary key for tool execution and should follow a clear naming pattern (e.g., `calculator_arithmetic` rather than just `calculate`)
311311
- **`title`**: A human-readable display name for the tool that clients can show to users
312312
- **`description`**: Detailed explanation of what the tool does and when to use it
313313
- **`inputSchema`**: A JSON Schema that defines the expected input parameters, enabling type validation and providing clear documentation about required and optional parameters
@@ -332,7 +332,7 @@ The client can now execute a tool using the `tools/call` method. This demonstrat
332332

333333
#### Understanding the Tool Execution Request
334334

335-
The `tools/call` request follows a structured format that ensures type safety and clear communication between client and server. Note that we're using the proper tool name from the discovery response (`com.example.weather/current`) rather than a simplified name:
335+
The `tools/call` request follows a structured format that ensures type safety and clear communication between client and server. Note that we're using the proper tool name from the discovery response (`weather_current`) rather than a simplified name:
336336

337337
<CodeGroup>
338338
```json Request
@@ -341,7 +341,7 @@ The `tools/call` request follows a structured format that ensures type safety an
341341
"id": 3,
342342
"method": "tools/call",
343343
"params": {
344-
"name": "com.example.weather/current",
344+
"name": "weather_current",
345345
"arguments": {
346346
"location": "San Francisco",
347347
"units": "imperial"
@@ -369,7 +369,7 @@ The `tools/call` request follows a structured format that ensures type safety an
369369

370370
The request structure includes several important components:
371371

372-
1. **`name`**: Must match exactly the tool name from the discovery response (`com.example.weather/current`). This ensures the server can correctly identify which tool to execute.
372+
1. **`name`**: Must match exactly the tool name from the discovery response (`weather_current`). This ensures the server can correctly identify which tool to execute.
373373

374374
2. **`arguments`**: Contains the input parameters as defined by the tool's `inputSchema`. In this example:
375375

0 commit comments

Comments
 (0)