feat: add prompts support to mcp-client, ahere to MCP spec for prompts
- add new endpoints `list_prompts` and `get_prompt` in the MCP client - update prompt model in mcp-core to make `description` and `arguments` optional, following MCP spec
This commit is contained in:
parent
fe1108c498
commit
08b73f3001
3 changed files with 78 additions and 25 deletions
|
|
@ -1,7 +1,7 @@
|
||||||
use mcp_core::protocol::{
|
use mcp_core::protocol::{
|
||||||
CallToolResult, Implementation, InitializeResult, JsonRpcError, JsonRpcMessage,
|
CallToolResult, GetPromptResult, Implementation, InitializeResult, JsonRpcError,
|
||||||
JsonRpcNotification, JsonRpcRequest, JsonRpcResponse, ListResourcesResult, ListToolsResult,
|
JsonRpcMessage, JsonRpcNotification, JsonRpcRequest, JsonRpcResponse, ListPromptsResult,
|
||||||
ReadResourceResult, ServerCapabilities, METHOD_NOT_FOUND,
|
ListResourcesResult, ListToolsResult, ReadResourceResult, ServerCapabilities, METHOD_NOT_FOUND,
|
||||||
};
|
};
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use serde_json::Value;
|
use serde_json::Value;
|
||||||
|
|
@ -93,6 +93,10 @@ pub trait McpClientTrait: Send + Sync {
|
||||||
async fn list_tools(&self, next_cursor: Option<String>) -> Result<ListToolsResult, Error>;
|
async fn list_tools(&self, next_cursor: Option<String>) -> Result<ListToolsResult, Error>;
|
||||||
|
|
||||||
async fn call_tool(&self, name: &str, arguments: Value) -> Result<CallToolResult, Error>;
|
async fn call_tool(&self, name: &str, arguments: Value) -> Result<CallToolResult, Error>;
|
||||||
|
|
||||||
|
async fn list_prompts(&self, next_cursor: Option<String>) -> Result<ListPromptsResult, Error>;
|
||||||
|
|
||||||
|
async fn get_prompt(&self, name: &str, arguments: Value) -> Result<GetPromptResult, Error>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The MCP client is the interface for MCP operations.
|
/// The MCP client is the interface for MCP operations.
|
||||||
|
|
@ -346,4 +350,42 @@ where
|
||||||
// https://modelcontextprotocol.io/docs/concepts/tools#error-handling-2
|
// https://modelcontextprotocol.io/docs/concepts/tools#error-handling-2
|
||||||
self.send_request("tools/call", params).await
|
self.send_request("tools/call", params).await
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async fn list_prompts(&self, next_cursor: Option<String>) -> Result<ListPromptsResult, Error> {
|
||||||
|
if !self.completed_initialization() {
|
||||||
|
return Err(Error::NotInitialized);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If prompts is not supported, return an error
|
||||||
|
if self.server_capabilities.as_ref().unwrap().prompts.is_none() {
|
||||||
|
return Err(Error::RpcError {
|
||||||
|
code: METHOD_NOT_FOUND,
|
||||||
|
message: "Server does not support 'prompts' capability".to_string(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
let payload = next_cursor
|
||||||
|
.map(|cursor| serde_json::json!({"cursor": cursor}))
|
||||||
|
.unwrap_or_else(|| serde_json::json!({}));
|
||||||
|
|
||||||
|
self.send_request("prompts/list", payload).await
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn get_prompt(&self, name: &str, arguments: Value) -> Result<GetPromptResult, Error> {
|
||||||
|
if !self.completed_initialization() {
|
||||||
|
return Err(Error::NotInitialized);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If prompts is not supported, return an error
|
||||||
|
if self.server_capabilities.as_ref().unwrap().prompts.is_none() {
|
||||||
|
return Err(Error::RpcError {
|
||||||
|
code: METHOD_NOT_FOUND,
|
||||||
|
message: "Server does not support 'prompts' capability".to_string(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
let params = serde_json::json!({ "name": name, "arguments": arguments });
|
||||||
|
|
||||||
|
self.send_request("prompts/get", params).await
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -10,22 +10,28 @@ use serde::{Deserialize, Serialize};
|
||||||
pub struct Prompt {
|
pub struct Prompt {
|
||||||
/// The name of the prompt
|
/// The name of the prompt
|
||||||
pub name: String,
|
pub name: String,
|
||||||
/// A description of what the prompt does
|
/// Optional description of what the prompt does
|
||||||
pub description: String,
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
/// The arguments that can be passed to customize the prompt
|
pub description: Option<String>,
|
||||||
pub arguments: Vec<PromptArgument>,
|
/// Optional arguments that can be passed to customize the prompt
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub arguments: Option<Vec<PromptArgument>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Prompt {
|
impl Prompt {
|
||||||
/// Create a new prompt with the given name, description and arguments
|
/// Create a new prompt with the given name, description and arguments
|
||||||
pub fn new<N, D>(name: N, description: D, arguments: Vec<PromptArgument>) -> Self
|
pub fn new<N, D>(
|
||||||
|
name: N,
|
||||||
|
description: Option<D>,
|
||||||
|
arguments: Option<Vec<PromptArgument>>,
|
||||||
|
) -> Self
|
||||||
where
|
where
|
||||||
N: Into<String>,
|
N: Into<String>,
|
||||||
D: Into<String>,
|
D: Into<String>,
|
||||||
{
|
{
|
||||||
Prompt {
|
Prompt {
|
||||||
name: name.into(),
|
name: name.into(),
|
||||||
description: description.into(),
|
description: description.map(Into::into),
|
||||||
arguments,
|
arguments,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -37,9 +43,11 @@ pub struct PromptArgument {
|
||||||
/// The name of the argument
|
/// The name of the argument
|
||||||
pub name: String,
|
pub name: String,
|
||||||
/// A description of what the argument is used for
|
/// A description of what the argument is used for
|
||||||
pub description: String,
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub description: Option<String>,
|
||||||
/// Whether this argument is required
|
/// Whether this argument is required
|
||||||
pub required: bool,
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub required: Option<bool>,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Represents the role of a message sender in a prompt conversation
|
/// Represents the role of a message sender in a prompt conversation
|
||||||
|
|
@ -151,6 +159,6 @@ pub struct PromptTemplate {
|
||||||
#[derive(Debug, Serialize, Deserialize)]
|
#[derive(Debug, Serialize, Deserialize)]
|
||||||
pub struct PromptArgumentTemplate {
|
pub struct PromptArgumentTemplate {
|
||||||
pub name: String,
|
pub name: String,
|
||||||
pub description: String,
|
pub description: Option<String>,
|
||||||
pub required: bool,
|
pub required: Option<bool>,
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -305,18 +305,21 @@ pub trait Router: Send + Sync + 'static {
|
||||||
};
|
};
|
||||||
|
|
||||||
// Validate required arguments
|
// Validate required arguments
|
||||||
for arg in &prompt.arguments {
|
if let Some(args) = &prompt.arguments {
|
||||||
if arg.required
|
for arg in args {
|
||||||
&& (!arguments.contains_key(&arg.name)
|
if arg.required.is_some()
|
||||||
|| arguments
|
&& arg.required.unwrap()
|
||||||
.get(&arg.name)
|
&& (!arguments.contains_key(&arg.name)
|
||||||
.and_then(Value::as_str)
|
|| arguments
|
||||||
.is_none_or(str::is_empty))
|
.get(&arg.name)
|
||||||
{
|
.and_then(Value::as_str)
|
||||||
return Err(RouterError::InvalidParams(format!(
|
.is_none_or(str::is_empty))
|
||||||
"Missing required argument: '{}'",
|
{
|
||||||
arg.name
|
return Err(RouterError::InvalidParams(format!(
|
||||||
)));
|
"Missing required argument: '{}'",
|
||||||
|
arg.name
|
||||||
|
)));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue