-
Notifications
You must be signed in to change notification settings - Fork 17
Example of custom mcp server extensions #145
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. | ||
| */ | ||
|
|
||
| import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js"; | ||
| import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js"; | ||
| import { GetPromptResult } from "@modelcontextprotocol/sdk/types.js"; | ||
| import { | ||
| objectOutputType, | ||
| ZodOptional, | ||
| ZodType, | ||
| ZodTypeAny, | ||
| ZodTypeDef, | ||
| } from "zod"; | ||
| import { UnstructuredClientCore } from "../core.js"; | ||
| import { ConsoleLogger } from "./console-logger.js"; | ||
| import { MCPScope } from "./scopes.js"; | ||
|
|
||
| // '@modelcontextprotocol/sdk' currently does not export this type | ||
| export type PromptArgsRawShape = { | ||
| [k: string]: | ||
| | ZodType<string, ZodTypeDef, string> | ||
| | ZodOptional<ZodType<string, ZodTypeDef, string>>; | ||
| }; | ||
|
|
||
| export type PromptDefinition< | ||
| Args extends undefined | PromptArgsRawShape = undefined, | ||
| > = Args extends PromptArgsRawShape ? { | ||
| name: string; | ||
| description?: string; | ||
| scopes?: MCPScope[]; | ||
| args: Args; | ||
| prompt: ( | ||
| client: UnstructuredClientCore, | ||
| args: objectOutputType<Args, ZodTypeAny>, | ||
| extra: RequestHandlerExtra, | ||
| ) => GetPromptResult | Promise<GetPromptResult>; | ||
| } | ||
| : { | ||
| name: string; | ||
| description?: string; | ||
| scopes?: MCPScope[]; | ||
| args?: undefined; | ||
| prompt: ( | ||
| client: UnstructuredClientCore, | ||
| extra: RequestHandlerExtra, | ||
| ) => GetPromptResult | Promise<GetPromptResult>; | ||
| }; | ||
|
|
||
| // Optional function to assist with formatting prompt results | ||
| export async function formatResult(value: string): Promise<GetPromptResult> { | ||
| return { | ||
| messages: [ | ||
| { | ||
| role: "user", | ||
| content: { | ||
| type: "text", | ||
| text: value, | ||
| }, | ||
| }, | ||
| ], | ||
| }; | ||
| } | ||
|
|
||
| export function createRegisterPrompt( | ||
| logger: ConsoleLogger, | ||
| server: McpServer, | ||
| sdk: UnstructuredClientCore, | ||
| allowedScopes: Set<MCPScope>, | ||
| ): <A extends PromptArgsRawShape | undefined>( | ||
| prompt: PromptDefinition<A>, | ||
| ) => void { | ||
| return <A extends PromptArgsRawShape | undefined>( | ||
| prompt: PromptDefinition<A>, | ||
| ): void => { | ||
| const scopes = prompt.scopes ?? []; | ||
| if (!scopes.every((s: MCPScope) => allowedScopes.has(s))) { | ||
| return; | ||
| } | ||
|
|
||
| if (prompt.args) { | ||
| if (prompt.description) { | ||
| server.prompt( | ||
| prompt.name, | ||
| prompt.description, | ||
| prompt.args, | ||
| async (args, ctx) => prompt.prompt(sdk, args, ctx), | ||
| ); | ||
| } else { | ||
| server.prompt( | ||
| prompt.name, | ||
| prompt.args, | ||
| async (args, ctx) => prompt.prompt(sdk, args, ctx), | ||
| ); | ||
| } | ||
| } else { | ||
| if (prompt.description) { | ||
| server.prompt( | ||
| prompt.name, | ||
| prompt.description, | ||
| async (ctx) => prompt.prompt(sdk, ctx), | ||
| ); | ||
| } else { | ||
| server.prompt(prompt.name, async (ctx) => prompt.prompt(sdk, ctx)); | ||
| } | ||
| } | ||
|
|
||
| logger.debug("Registered prompt", { name: prompt.name }); | ||
| }; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| import { formatResult, ToolDefinition } from "./tools.js"; | ||
| import { Register } from "./extensions.js"; | ||
| import { generalPartition } from "../funcs/generalPartition.js"; | ||
| import fs from 'node:fs/promises'; | ||
| import { UnstructuredClientCore } from "../core.js"; | ||
| import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js"; | ||
| import { z } from "zod"; | ||
| import { Strategy, Strategy$inboundSchema, StrategyOpen } from "../sdk/models/shared/partitionparameters.js"; | ||
|
|
||
|
|
||
| type FileRequest = { | ||
| strategy?: StrategyOpen | undefined; | ||
| file_content?: string | undefined; | ||
| file_path?: string | undefined; | ||
| file_name: string; | ||
| }; | ||
|
|
||
| const FileRequest$inboundSchema: z.ZodType< | ||
| FileRequest, | ||
| z.ZodTypeDef, | ||
| unknown | ||
| > = z.object({ | ||
| file_content: z.string().optional(), | ||
| file_path: z.string().optional(), | ||
| file_name: z.string(), | ||
| strategy: Strategy$inboundSchema.default(Strategy.HiRes), | ||
| }); | ||
|
|
||
| const customToolArg = { | ||
| request: FileRequest$inboundSchema | ||
| }; | ||
|
|
||
|
|
||
|
|
||
| export const tool$generalPartitionCorrect: ToolDefinition<typeof customToolArg> = { | ||
| name: "correct_general-partition", | ||
| description: `use this tool to pass a file to unstructured. You must BASE64 ENCODE uploaded file content before passing to unstructured. Alternatively, if the user did not upload a file they can provide a full local file path. `, | ||
| args: customToolArg, | ||
| tool: async (client: UnstructuredClientCore, args, ctx: RequestHandlerExtra) => { | ||
| let data: Uint8Array; | ||
| if (args.request.file_content) { | ||
| try { | ||
| data = new Uint8Array(Buffer.from(args.request.file_content, 'base64')); | ||
| } catch (e) { | ||
| return { | ||
| content: [{ | ||
| type: "text", | ||
| text: `You must BASE64 encode this file content then pass it to the tool.`, | ||
| }], | ||
| isError: true, | ||
| }; | ||
| } | ||
| } else if (args.request.file_path) { | ||
| data = new Uint8Array(await fs.readFile(args.request.file_path)); | ||
| } else { | ||
| return { | ||
| content: [{ | ||
| type: "text", | ||
| text: `A full file path for file content must be provided`, | ||
| }], | ||
| isError: true, | ||
| }; | ||
| } | ||
| const [result, apiCall] = await generalPartition( | ||
| client, | ||
| { | ||
| partitionParameters: { | ||
| files: { | ||
| content: data, | ||
| fileName: args.request.file_name, | ||
| }, | ||
| strategy: args.request.strategy, | ||
| } | ||
| }, | ||
| { fetchOptions: { signal: ctx.signal } }, | ||
| ).$inspect(); | ||
|
|
||
| if (!result.ok) { | ||
| return { | ||
| content: [{ type: "text", text: result.error.message }], | ||
| isError: true, | ||
| }; | ||
| } | ||
|
|
||
| const value = result.value; | ||
|
|
||
| return formatResult(value, apiCall); | ||
| }, | ||
| }; | ||
|
|
||
| export function registerMCPExtensions(register: Register): void { | ||
| register.tool(tool$generalPartitionCorrect); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can and probably should expose more args here. This was just a quick demo I spun up