feat(ai): support InitializeResult.instructions on McpServer#6224
Open
richburdon wants to merge 6 commits intoEffect-TS:mainfrom
Open
feat(ai): support InitializeResult.instructions on McpServer#6224richburdon wants to merge 6 commits intoEffect-TS:mainfrom
richburdon wants to merge 6 commits intoEffect-TS:mainfrom
Conversation
Update OpenAi client to work with "openai-compatible" providers
Add an optional `instructions` field to the `McpServer` layer options (`layer`, `layerStdio`, `layerHttp`, `layerHttpRouter`). When provided, the string is returned in the `InitializeResult.instructions` field per the MCP spec, giving servers a built-in way to inject system-prompt-level guidance into clients at session start. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 242c342 The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Add an optional
instructionsfield to theMcpServerlayer options(
layer,layerStdio,layerHttp,layerHttpRouter). When provided, thestring is returned in the
InitializeResult.instructionsfield per theMCP spec.
InitializeResult.instructionsis the built-in MCP mechanism for a serverto inject system-prompt-level guidance into the client at session start.
The current
@effect/aiAPI doesn't expose it, forcing downstream usersto either fork or post-process JSON-RPC responses to add it. The schema in
McpSchema.InitializeResultalready supports the field — this PR justplumbs it through the public layer constructors.
The option is purely additive and omitted from the response when not set
(no
instructions: undefinedis emitted).Before
After
Test plan
pnpm check(tsc strict) passespnpm testpasses — added two tests inpackages/ai/ai/test/McpServer.test.ts:InitializeResult.instructions === "be helpful"when the option is set@effect/aiminor — additive API)🤖 Generated with Claude Code