mirror of
https://github.com/openai/codex.git
synced 2026-05-03 19:06:58 +00:00
We started working with MCP in Codex before
https://crates.io/crates/rmcp was mature, so we had our own crate for
MCP types that was generated from the MCP schema:
8b95d3e082/codex-rs/mcp-types/README.md
Now that `rmcp` is more mature, it makes more sense to use their MCP
types in Rust, as they handle details (like the `_meta` field) that our
custom version ignored. Though one advantage that our custom types had
is that our generated types implemented `JsonSchema` and `ts_rs::TS`,
whereas the types in `rmcp` do not. As such, part of the work of this PR
is leveraging the adapters between `rmcp` types and the serializable
types that are API for us (app server and MCP) introduced in #10356.
Note this PR results in a number of changes to
`codex-rs/app-server-protocol/schema`, which merit special attention
during review. We must ensure that these changes are still
backwards-compatible, which is possible because we have:
```diff
- export type CallToolResult = { content: Array<ContentBlock>, isError?: boolean, structuredContent?: JsonValue, };
+ export type CallToolResult = { content: Array<JsonValue>, structuredContent?: JsonValue, isError?: boolean, _meta?: JsonValue, };
```
so `ContentBlock` has been replaced with the more general `JsonValue`.
Note that `ContentBlock` was defined as:
```typescript
export type ContentBlock = TextContent | ImageContent | AudioContent | ResourceLink | EmbeddedResource;
```
so the deletion of those individual variants should not be a cause of
great concern.
Similarly, we have the following change in
`codex-rs/app-server-protocol/schema/typescript/Tool.ts`:
```
- export type Tool = { annotations?: ToolAnnotations, description?: string, inputSchema: ToolInputSchema, name: string, outputSchema?: ToolOutputSchema, title?: string, };
+ export type Tool = { name: string, title?: string, description?: string, inputSchema: JsonValue, outputSchema?: JsonValue, annotations?: JsonValue, icons?: Array<JsonValue>, _meta?: JsonValue, };
```
so:
- `annotations?: ToolAnnotations` ➡️ `JsonValue`
- `inputSchema: ToolInputSchema` ➡️ `JsonValue`
- `outputSchema?: ToolOutputSchema` ➡️ `JsonValue`
and two new fields: `icons?: Array<JsonValue>, _meta?: JsonValue`
---
[//]: # (BEGIN SAPLING FOOTER)
Stack created with [Sapling](https://sapling-scm.com). Best reviewed
with [ReviewStack](https://reviewstack.dev/openai/codex/pull/10349).
* #10357
* __->__ #10349
* #10356
136 lines
4.1 KiB
Rust
136 lines
4.1 KiB
Rust
use std::sync::Arc;
|
|
|
|
use rmcp::ClientHandler;
|
|
use rmcp::RoleClient;
|
|
use rmcp::model::CancelledNotificationParam;
|
|
use rmcp::model::ClientInfo;
|
|
use rmcp::model::CreateElicitationRequestParam;
|
|
use rmcp::model::CreateElicitationResult;
|
|
use rmcp::model::LoggingLevel;
|
|
use rmcp::model::LoggingMessageNotificationParam;
|
|
use rmcp::model::ProgressNotificationParam;
|
|
use rmcp::model::ResourceUpdatedNotificationParam;
|
|
use rmcp::service::NotificationContext;
|
|
use rmcp::service::RequestContext;
|
|
use tracing::debug;
|
|
use tracing::error;
|
|
use tracing::info;
|
|
use tracing::warn;
|
|
|
|
use crate::rmcp_client::SendElicitation;
|
|
|
|
#[derive(Clone)]
|
|
pub(crate) struct LoggingClientHandler {
|
|
client_info: ClientInfo,
|
|
send_elicitation: Arc<SendElicitation>,
|
|
}
|
|
|
|
impl LoggingClientHandler {
|
|
pub(crate) fn new(client_info: ClientInfo, send_elicitation: SendElicitation) -> Self {
|
|
Self {
|
|
client_info,
|
|
send_elicitation: Arc::new(send_elicitation),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl ClientHandler for LoggingClientHandler {
|
|
async fn create_elicitation(
|
|
&self,
|
|
request: CreateElicitationRequestParam,
|
|
context: RequestContext<RoleClient>,
|
|
) -> Result<CreateElicitationResult, rmcp::ErrorData> {
|
|
(self.send_elicitation)(context.id, request)
|
|
.await
|
|
.map_err(|err| rmcp::ErrorData::internal_error(err.to_string(), None))
|
|
}
|
|
|
|
async fn on_cancelled(
|
|
&self,
|
|
params: CancelledNotificationParam,
|
|
_context: NotificationContext<RoleClient>,
|
|
) {
|
|
info!(
|
|
"MCP server cancelled request (request_id: {}, reason: {:?})",
|
|
params.request_id, params.reason
|
|
);
|
|
}
|
|
|
|
async fn on_progress(
|
|
&self,
|
|
params: ProgressNotificationParam,
|
|
_context: NotificationContext<RoleClient>,
|
|
) {
|
|
info!(
|
|
"MCP server progress notification (token: {:?}, progress: {}, total: {:?}, message: {:?})",
|
|
params.progress_token, params.progress, params.total, params.message
|
|
);
|
|
}
|
|
|
|
async fn on_resource_updated(
|
|
&self,
|
|
params: ResourceUpdatedNotificationParam,
|
|
_context: NotificationContext<RoleClient>,
|
|
) {
|
|
info!("MCP server resource updated (uri: {})", params.uri);
|
|
}
|
|
|
|
async fn on_resource_list_changed(&self, _context: NotificationContext<RoleClient>) {
|
|
info!("MCP server resource list changed");
|
|
}
|
|
|
|
async fn on_tool_list_changed(&self, _context: NotificationContext<RoleClient>) {
|
|
info!("MCP server tool list changed");
|
|
}
|
|
|
|
async fn on_prompt_list_changed(&self, _context: NotificationContext<RoleClient>) {
|
|
info!("MCP server prompt list changed");
|
|
}
|
|
|
|
fn get_info(&self) -> ClientInfo {
|
|
self.client_info.clone()
|
|
}
|
|
|
|
async fn on_logging_message(
|
|
&self,
|
|
params: LoggingMessageNotificationParam,
|
|
_context: NotificationContext<RoleClient>,
|
|
) {
|
|
let LoggingMessageNotificationParam {
|
|
level,
|
|
logger,
|
|
data,
|
|
} = params;
|
|
let logger = logger.as_deref();
|
|
match level {
|
|
LoggingLevel::Emergency
|
|
| LoggingLevel::Alert
|
|
| LoggingLevel::Critical
|
|
| LoggingLevel::Error => {
|
|
error!(
|
|
"MCP server log message (level: {:?}, logger: {:?}, data: {})",
|
|
level, logger, data
|
|
);
|
|
}
|
|
LoggingLevel::Warning => {
|
|
warn!(
|
|
"MCP server log message (level: {:?}, logger: {:?}, data: {})",
|
|
level, logger, data
|
|
);
|
|
}
|
|
LoggingLevel::Notice | LoggingLevel::Info => {
|
|
info!(
|
|
"MCP server log message (level: {:?}, logger: {:?}, data: {})",
|
|
level, logger, data
|
|
);
|
|
}
|
|
LoggingLevel::Debug => {
|
|
debug!(
|
|
"MCP server log message (level: {:?}, logger: {:?}, data: {})",
|
|
level, logger, data
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|