Skip to content

docs: add early version of the resources spec #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsp-ant merged 8 commits into from
Oct 3, 2024
Merged

docs: add early version of the resources spec #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
67c7af2
docs: add early version of the resources spec
dsp-ant Oct 2, 2024
8fe2651
Update docs/spec/resources.md
dsp-ant Oct 3, 2024
f51a83b
Update docs/spec/resources.md
dsp-ant Oct 3, 2024
a4c9177
Update docs/spec/resources.md
dsp-ant Oct 3, 2024
63ef748
Update docs/spec/resources.md
dsp-ant Oct 3, 2024
340d0bd
Update docs/spec/resources.md
dsp-ant Oct 3, 2024
6d84d5b
Additional phrasing work
dsp-ant Oct 3, 2024
bb2a11f
Add required capabilities for resources
dsp-ant Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/spec/prompts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down Expand Up @@ -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.

Expand Down
Loading