Skip to content

Commit 22c5c9a

Browse files
committed
Add more links and tweaks
1 parent 06bdaef commit 22c5c9a

File tree

2 files changed

+21
-16
lines changed

2 files changed

+21
-16
lines changed

docs/protocol/initialization.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ The Client **SHOULD** specify whether it supports the following capability:
100100

101101
#### FileSystem
102102

103-
The Client **MAY** expose its FileSystem abstraction to varying degrees:
103+
The Client **MAY** expose its [File System](./file-system) abstraction to varying degrees:
104104

105105
<ParamField path="readTextFile" type="boolean">
106106
The `fs/read_text_file` method is available.
@@ -115,19 +115,19 @@ The Client **MAY** expose its FileSystem abstraction to varying degrees:
115115
The Agent **SHOULD** specify whether it supports the following capabilities:
116116

117117
<ResponseField name="loadSession" type="boolean" post={["default: false"]}>
118-
The `session/load` method is available.
118+
The [`session/load`](./session-setup#loading-sessions) method is available.
119119
</ResponseField>
120120

121121
<ResponseField name="promptCapabilities" type="PromptCapabilities Object">
122-
Object indicating the different types of content that may be included in
122+
Object indicating the different types of [content](./content) that may be included in
123123
`session/prompt` requests.
124124
</ResponseField>
125125

126126
#### Prompt capabilities
127127

128128
As a baseline, all Agents **MUST** support `ContentBlock::Text` and `ContentBlock::ResourceLink` in `session/prompt` requests.
129129

130-
Optionally, they **MAY** support richer types of content by specifying the following capabilities:
130+
Optionally, they **MAY** support richer types of [content](./content) by specifying the following capabilities:
131131

132132
<ResponseField name="image" type="boolean" post={["default: false"]}>
133133
The prompt may include `ContentBlock::Image`
@@ -138,7 +138,7 @@ Optionally, they **MAY** support richer types of content by specifying the follo
138138
</ResponseField>
139139

140140
<ResponseField name="embeddedContext" type="boolean" post={["default: false"]}>
141-
The prompt may include `ContentBlock::EmbeddedResource`
141+
The prompt may include `ContentBlock::Resource`
142142
</ResponseField>
143143

144144
---

docs/protocol/overview.mdx

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ A typical conversation follows this pattern:
2525
</Step>
2626

2727
<Step title="Session Setup">
28-
Either: - Client → Agent: `session/new` to create a new session - Client →
29-
Agent: `session/load` to resume an existing session if supported
28+
Either:
29+
- Client → Agent: `session/new` to create a new session
30+
- Client → Agent: `session/load` to resume an existing session if supported
3031
</Step>
3132

3233
<Step title="Prompt Turn">
@@ -45,27 +46,31 @@ Agents are programs that use generative AI to autonomously modify code. They typ
4546
### Baseline Methods
4647

4748
<ParamField path="initialize">
48-
Establish connection and negotiate capabilities.
49+
[Negotiate versions and exchange capabilities.](./initialization)
4950
</ParamField>
5051

5152
<ParamField path="authenticate">
5253
Authenticate with the Agent (if required).
5354
</ParamField>
5455

55-
<ParamField path="session/new">Create a new conversation session.</ParamField>
56+
<ParamField path="session/new">
57+
[Create a new conversation session](./session-setup#creating-a-session).
58+
</ParamField>
5659

57-
<ParamField path="session/prompt">Send user prompts to the Agent.</ParamField>
60+
<ParamField path="session/prompt">
61+
[Send user prompts](./prompt-turn#1-user-message) to the Agent.
62+
</ParamField>
5863

5964
### Optional Methods
6065

6166
<ParamField path="session/load">
62-
Load an existing session (requires `loadSession` capability).
67+
[Load an existing session](./session-setup#loading-sessions) (requires `loadSession` capability).
6368
</ParamField>
6469

6570
### Notifications
6671

6772
<ParamField path="session/cancel">
68-
Cancel ongoing operations (no response expected).
73+
[Cancel ongoing operations](./prompt-turn#cancellation) (no response expected).
6974
</ParamField>
7075

7176
## Client
@@ -75,23 +80,23 @@ Clients provide the interface between users and agents. They are typically code
7580
### Baseline Methods
7681

7782
<ParamField path="session/request_permission">
78-
Request user authorization for tool calls.
83+
[Request user authorization](./tool-calls#requesting-permission) for tool calls.
7984
</ParamField>
8085

8186
### Optional Methods
8287

8388
<ParamField path="fs/read_text_file">
84-
Read file contents (requires `fs.readTextFile` capability).
89+
[Read file contents](./file-system#reading-files) (requires `fs.readTextFile` capability).
8590
</ParamField>
8691

8792
<ParamField path="fs/write_text_file">
88-
Write file contents (requires `fs.writeTextFile` capability).
93+
[Write file contents](./file-system#writing-files) (requires `fs.writeTextFile` capability).
8994
</ParamField>
9095

9196
### Notifications
9297

9398
<ParamField path="session/update">
94-
Send progress updates during prompt processing (no response expected).
99+
[Send progress updates](./prompt-turn#3-agent-reports-output) during prompt processing (no response expected).
95100
</ParamField>
96101

97102
## Error Handling

0 commit comments

Comments
 (0)