Merge pull request #35 from modelcontextprotocol/justin/conveniences

Add convenience methods for issuing requests
This commit is contained in:
Justin Spahr-Summers 2024-11-05 16:54:49 +00:00 • committed by GitHub
commit e95e91a77c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 167 additions and 2 deletions

View file

@ -1,4 +1,4 @@
import { Protocol } from "../shared/protocol.js";
import { ProgressCallback, Protocol } from "../shared/protocol.js";
import { Transport } from "../shared/transport.js";
import {
ClientNotification,
@ -11,6 +11,24 @@ import {
Request,
Result,
ServerCapabilities,
CompleteRequest,
GetPromptRequest,
ListPromptsRequest,
ListResourcesRequest,
ReadResourceRequest,
SubscribeRequest,
UnsubscribeRequest,
CallToolRequest,
ListToolsRequest,
CompleteResultSchema,
GetPromptResultSchema,
ListPromptsResultSchema,
ListResourcesResultSchema,
ReadResourceResultSchema,
CallToolResultSchema,
ListToolsResultSchema,
EmptyResultSchema,
LoggingLevel,
} from "../types.js";
/**
@ -103,4 +121,106 @@ export class Client<
getServerVersion(): Implementation | undefined {
return this._serverVersion;
}
async ping() {
return this.request({ method: "ping" }, EmptyResultSchema);
}
async complete(
params: CompleteRequest["params"],
onprogress?: ProgressCallback,
) {
return this.request(
{ method: "completion/complete", params },
CompleteResultSchema,
onprogress,
);
}
async setLoggingLevel(level: LoggingLevel) {
return this.request(
{ method: "logging/setLevel", params: { level } },
EmptyResultSchema,
);
}
async getPrompt(
params: GetPromptRequest["params"],
onprogress?: ProgressCallback,
) {
return this.request(
{ method: "prompts/get", params },
GetPromptResultSchema,
onprogress,
);
}
async listPrompts(
params?: ListPromptsRequest["params"],
onprogress?: ProgressCallback,
) {
return this.request(
{ method: "prompts/list", params },
ListPromptsResultSchema,
onprogress,
);
}
async listResources(
params?: ListResourcesRequest["params"],
onprogress?: ProgressCallback,
) {
return this.request(
{ method: "resources/list", params },
ListResourcesResultSchema,
onprogress,
);
}
async readResource(
params: ReadResourceRequest["params"],
onprogress?: ProgressCallback,
) {
return this.request(
{ method: "resources/read", params },
ReadResourceResultSchema,
onprogress,
);
}
async subscribeResource(params: SubscribeRequest["params"]) {
return this.request(
{ method: "resources/subscribe", params },
EmptyResultSchema,
);
}
async unsubscribeResource(params: UnsubscribeRequest["params"]) {
return this.request(
{ method: "resources/unsubscribe", params },
EmptyResultSchema,
);
}
async callTool(
params: CallToolRequest["params"],
onprogress?: ProgressCallback,
) {
return this.request(
{ method: "tools/call", params },
CallToolResultSchema,
onprogress,
);
}
async listTools(
params?: ListToolsRequest["params"],
onprogress?: ProgressCallback,
) {
return this.request(
{ method: "tools/list", params },
ListToolsResultSchema,
onprogress,
);
}
}

View file

@ -1,4 +1,4 @@
import { Protocol } from "../shared/protocol.js";
import { ProgressCallback, Protocol } from "../shared/protocol.js";
import {
ClientCapabilities,
Implementation,
@ -18,6 +18,11 @@ import {
ListToolsRequestSchema,
ListPromptsRequestSchema,
SetLevelRequestSchema,
CreateMessageRequest,
CreateMessageResultSchema,
EmptyResultSchema,
LoggingMessageNotification,
ResourceUpdatedNotification,
} from "../types.js";
/**
@ -133,4 +138,44 @@ export class Server<
: undefined,
};
}
async ping() {
return this.request({ method: "ping" }, EmptyResultSchema);
}
async createMessage(
params: CreateMessageRequest["params"],
onprogress?: ProgressCallback,
) {
return this.request(
{ method: "sampling/createMessage", params },
CreateMessageResultSchema,
onprogress,
);
}
async sendLoggingMessage(params: LoggingMessageNotification["params"]) {
return this.notification({ method: "notifications/message", params });
}
async sendResourceUpdated(params: ResourceUpdatedNotification["params"]) {
return this.notification({
method: "notifications/resources/updated",
params,
});
}
async sendResourceListChanged() {
return this.notification({
method: "notifications/resources/list_changed",
});
}
async sendToolListChanged() {
return this.notification({ method: "notifications/tools/list_changed" });
}
async sendPromptListChanged() {
return this.notification({ method: "notifications/prompts/list_changed" });
}
}