Skip to content

Commit bf18278

Browse files
committed
Merge branch 'main' into ihrpr/sdk-docs
2 parents 7f90165 + 5b1c2ff commit bf18278

File tree

6 files changed

+253
-73
lines changed

6 files changed

+253
-73
lines changed

docs/specification/draft/basic/lifecycle.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ The client **MUST** initiate this phase by sending an `initialize` request conta
6868
},
6969
"clientInfo": {
7070
"name": "ExampleClient",
71+
"title": "Example Client Display Name",
7172
"version": "1.0.0"
7273
}
7374
}
@@ -97,6 +98,7 @@ The server **MUST** respond with its own capabilities and information:
9798
},
9899
"serverInfo": {
99100
"name": "ExampleServer",
101+
"title": "Example Server Display Name",
100102
"version": "1.0.0"
101103
},
102104
"instructions": "Optional instructions for the client"

docs/specification/draft/server/prompts.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ supports [pagination](/specification/draft/server/utilities/pagination).
7575
"prompts": [
7676
{
7777
"name": "code_review",
78+
"title": "Request Code Review",
7879
"description": "Asks the LLM to analyze code quality and suggest improvements",
7980
"arguments": [
8081
{
@@ -174,6 +175,7 @@ sequenceDiagram
174175
A prompt definition includes:
175176

176177
- `name`: Unique identifier for the prompt
178+
- `title`: Optional human-readable name of the prompt for display purposes.
177179
- `description`: Optional human-readable description
178180
- `arguments`: Optional list of arguments for customization
179181

@@ -236,6 +238,8 @@ Embedded resources allow referencing server-side resources directly in messages:
236238
"type": "resource",
237239
"resource": {
238240
"uri": "resource://example",
241+
"name": "example",
242+
"title": "My Example Resource",
239243
"mimeType": "text/plain",
240244
"text": "Resource content"
241245
}

docs/specification/draft/server/resources.mdx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ supports [pagination](/specification/draft/server/utilities/pagination).
113113
{
114114
"uri": "file:///project/src/main.rs",
115115
"name": "main.rs",
116+
"title": "Rust Software Application Main File",
116117
"description": "Primary application entry point",
117118
"mimeType": "text/x-rust"
118119
}
@@ -149,6 +150,8 @@ To retrieve resource contents, clients send a `resources/read` request:
149150
"contents": [
150151
{
151152
"uri": "file:///project/src/main.rs",
153+
"name": "main.rs",
154+
"title": "Rust Software Application Main File",
152155
"mimeType": "text/x-rust",
153156
"text": "fn main() {\n println!(\"Hello world!\");\n}"
154157
}
@@ -184,6 +187,7 @@ auto-completed through [the completion API](/specification/draft/server/utilitie
184187
{
185188
"uriTemplate": "file:///{path}",
186189
"name": "Project Files",
190+
"title": "📁 Project Files",
187191
"description": "Access files in the project directory",
188192
"mimeType": "application/octet-stream"
189193
}
@@ -229,7 +233,8 @@ to specific resources and receive notifications when they change:
229233
"jsonrpc": "2.0",
230234
"method": "notifications/resources/updated",
231235
"params": {
232-
"uri": "file:///project/src/main.rs"
236+
"uri": "file:///project/src/main.rs",
237+
"title": "Rust Software Application Main File"
233238
}
234239
}
235240
```
@@ -266,7 +271,8 @@ sequenceDiagram
266271
A resource definition includes:
267272

268273
- `uri`: Unique identifier for the resource
269-
- `name`: Human-readable name
274+
- `name`: The name of the resource.
275+
- `title`: Optional human-readable name of the resource for display purposes.
270276
- `description`: Optional description
271277
- `mimeType`: Optional MIME type
272278
- `size`: Optional size in bytes
@@ -280,6 +286,8 @@ Resources can contain either text or binary data:
280286
```json
281287
{
282288
"uri": "file:///example.txt",
289+
"name": "example.txt",
290+
"title": "Example Text File",
283291
"mimeType": "text/plain",
284292
"text": "Resource content"
285293
}
@@ -290,6 +298,8 @@ Resources can contain either text or binary data:
290298
```json
291299
{
292300
"uri": "file:///example.png",
301+
"name": "example.png",
302+
"title": "Example Image",
293303
"mimeType": "image/png",
294304
"blob": "base64-encoded-data"
295305
}

docs/specification/draft/server/tools.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ To discover available tools, clients send a `tools/list` request. This operation
8282
"tools": [
8383
{
8484
"name": "get_weather",
85+
"title": "Weather Information Provider",
8586
"description": "Get current weather information for a location",
8687
"inputSchema": {
8788
"type": "object",
@@ -183,6 +184,7 @@ sequenceDiagram
183184
A tool definition includes:
184185

185186
- `name`: Unique identifier for the tool
187+
- `title`: Optional human-readable name of the tool for display purposes.
186188
- `description`: Human-readable description of functionality
187189
- `inputSchema`: JSON Schema defining expected parameters
188190
- `outputSchema`: Optional JSON Schema defining expected output structure
@@ -260,6 +262,7 @@ or data using a suitable [URI scheme](./resources#common-uri-schemes). Servers t
260262
"type": "resource",
261263
"resource": {
262264
"uri": "file:///project/src/main.rs",
265+
"title": "Project Rust Main File",
263266
"mimeType": "text/x-rust",
264267
"text": "fn main() {\n println!(\"Hello world!\");\n}"
265268
}
@@ -286,6 +289,7 @@ Example tool with output schema:
286289
```json
287290
{
288291
"name": "get_weather_data",
292+
"title": "Weather Data Retriever",
289293
"description": "Get current weather data for a location",
290294
"inputSchema": {
291295
"type": "object",

0 commit comments

Comments
 (0)