Merge pull request #13 from modelcontextprotocol/davidsp/resources

docs: add early version of the resources spec
modelcontextprotocol · Oct 3, 2024 · 6be0e7d · 6be0e7d
2 parents bb9572d + bb2a11f
commit 6be0e7d
Show file tree

Hide file tree

Showing 2 changed files with 426 additions and 2 deletions.
diff --git a/docs/spec/prompts.md b/docs/spec/prompts.md
@@ -4,7 +4,7 @@ type: docs
 weight: 3
 ---
 
-The Prompts API allows clients to retrieve information about available prompts and prompt templates from the server.
+The Prompts API allows clients to retrieve information about available prompts and prompt templates from the server. Prompts are templated conversations with a model that the client can retrieve. Commonly clients present available prompts to users as slash/at commands or similar approaches, e.g. by typing `/a-prompt`.
 
 ## Capabilities
 
@@ -24,6 +24,8 @@ sequenceDiagram
     Server-->>Client: GetPromptResult
 ```
 
+# Messages
+
 ## List Prompts
 
 The client **SHOULD** send a `prompts/list` request to retrieve a list of available prompts and prompt templates from the server.
@@ -74,7 +76,8 @@ Argument definitions, if present, **MUST** include:
 - required: An optional boolean indicating if the argument is required
 
 The server **SHOULD** provide descriptive names and descriptions to help clients understand the purpose and usage of each prompt or template.
-## Get Prompt
+
+## Getting a prompt
 
 To retrieve a specific prompt or instantiate a prompt template, the client **SHOULD** send a `prompts/get` request.