Repository navigation
feat(cli): advertise MCP server instructions - #4889
Open
ali-beamable wants to merge 1 commit into
Open
ali-beamable wants to merge 1 commit into
ali-beamable wants to merge 1 commit into
Conversation
beam mcp serve never set ServerInstructions, so agents started with no Beamable-specific context. Send a short embedded markdown file (Docs/Mcp/ServerInstructions.md) covering the skill-first workflow, -q, the @beamable/sdk package name, the web-client generator, the realm prerequisites for the Web SDK, how Beam.init realtime fails, microservice basics and the deploy release --replace default. Tests start an in-memory MCP server and client and check the advertised instructions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SR1QFkbVnMgqpzAeej2HHv
Contributor
|
Lightbeam link |
This branch has not been deployed
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
2 participants
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.
Ticket
None. This comes from an agent-friendliness review of building a web game with the CLI and Web SDK.
Brief Description
beam mcp servenever setServerInstructions, so MCP clients start with no Beamable-specific context. This adds a short instructions file (26 lines) that the server sends duringinitialize. It lives in an embedded markdown file,cli/cli/Docs/Mcp/ServerInstructions.md, so it's easy to edit. It covers:-q@beamable/sdkpackage name, andproject generate web-client, which needs a build firstnotification|publisher=beamableand a publishedglobalmanifestBeam.inithang presentsPromise<T>is awaitable, DTOs use public fields,Context.UserIddeploy release --replacedefaultChecklist
Notes
McpServerInstructionsTestschecks the embedded file (key facts, at most 40 lines). It also starts an in-memory MCP server and client over pipes and readsclient.ServerInstructions.beam_exec, realm by name, realm check, project call, probe) add their own lines to this file in the agent-docs PR, so this PR only describes behavior already onmain.🤖 Generated with Claude Code
https://claude.ai/code/session_01SR1QFkbVnMgqpzAeej2HHv
Generated by Claude Code