Skip to content

Commit 232cd3f

Browse files
committed
docs: trim protocol docs for clarity
1 parent a9587b4 commit 232cd3f

File tree

3 files changed

+0
-47
lines changed

3 files changed

+0
-47
lines changed

src/conduit/protocol/completions.py

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
11
"""
22
Autocomplete support for MCP prompt and resource arguments.
33
4-
MCP enables servers to offer reusable, parameterized prompts - think "code review"
5-
templates that take language, focus area, and code as arguments. When users fill
6-
out these templates, they need smart autocomplete for argument values.
7-
8-
## The Completion Flow
9-
10-
1. **Discovery**: Client discovers available prompts and their argument schemas
11-
2. **User Input**: User selects a prompt and starts filling argument values
12-
3. **Completion**: As they type, client requests suggestions for the current argument
13-
4. **Suggestions**: Server responds with relevant completions based on partial input
14-
154
For example, a "weather" prompt with a `city` argument might suggest
165
"San Francisco", "San Diego", "San Antonio" when the user types "San".
176

src/conduit/protocol/roots.py

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,6 @@
3333
class Root(ProtocolModel):
3434
"""
3535
A filesystem resource that the server can access.
36-
37-
Roots define the boundaries of what a server can work with—think of them as
38-
declaring "here are the directories and files you're allowed to touch."
39-
This creates a secure sandbox while enabling servers to apply their domain
40-
expertise to your local content.
41-
42-
Instead of manually feeding files into conversations, you can point servers
43-
at project directories and let them intelligently traverse, analyze, and
44-
work with the file structure as their capabilities require.
4536
"""
4637

4738
uri: str
@@ -69,10 +60,6 @@ class Root(ProtocolModel):
6960
class ListRootsRequest(Request):
7061
"""
7162
Server request to discover what filesystem locations it can access.
72-
73-
Servers send this to understand their operating boundaries—what directories
74-
and files the client has made available. This shapes how the server can
75-
apply its capabilities to the client's content.
7663
"""
7764

7865
method: Literal["roots/list"] = "roots/list"
@@ -96,11 +83,6 @@ class ListRootsResult(Result):
9683
class RootsListChangedNotification(Notification):
9784
"""
9885
Client notification that filesystem access boundaries have changed.
99-
100-
Sent when roots are added, removed, or modified—perhaps when users
101-
open new projects or revoke access to directories. Servers typically
102-
respond by requesting the updated root list to understand their new
103-
operating scope.
10486
"""
10587

10688
method: Literal["notifications/roots/list_changed"] = (

src/conduit/protocol/tools.py

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
"""
22
Tool system for extending LLM capabilities beyond text generation.
33
4-
Tools solve a fundamental limitation: LLMs can describe actions but can't perform them.
5-
By defining callable functions through MCP, you enable LLMs to interact with your
6-
systems, APIs, and data sources automatically based on conversation context.
7-
8-
## The Tool Lifecycle
9-
10-
1. **Discovery** - Clients ask servers "what can you do?" via ListToolsRequest
11-
2. **Selection** - LLMs choose appropriate tools based on descriptions and behavioral
12-
hints
13-
3. **Execution** - Clients invoke tools with CallToolRequest, passing structured
14-
arguments
15-
4. **Integration** - Tool results become conversation context the LLM can build upon
16-
174
## Designing Effective Tools
185
196
Tools work best when they represent clear, focused capabilities. Instead of a generic
@@ -28,11 +15,6 @@
2815
Use ToolAnnotations to guide LLM decision-making. For example, mark tools as
2916
read-only, destructive, or open-world to help LLMs understand when and how to
3017
use them.
31-
32-
Tool results can include rich content: text responses, images, audio, or embedded
33-
server resources. The error handling model keeps failures visible to the LLM rather
34-
than breaking the conversation flow, enabling intelligent recovery and alternative
35-
approaches.
3618
"""
3719

3820
from typing import Any, Literal

0 commit comments

Comments
 (0)