-
Notifications
You must be signed in to change notification settings - Fork 56
Add {AGENTS,CLAUDE}.md for AI assistant guidance
#218
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
base: main
Are you sure you want to change the base?
Add {AGENTS,CLAUDE}.md for AI assistant guidance
#218
Conversation
@modelcontextprotocol/ext-apps
@modelcontextprotocol/server-basic-react
@modelcontextprotocol/server-basic-vanillajs
@modelcontextprotocol/server-budget-allocator
@modelcontextprotocol/server-cohort-heatmap
@modelcontextprotocol/server-customer-segmentation
@modelcontextprotocol/server-scenario-modeler
@modelcontextprotocol/server-system-monitor
@modelcontextprotocol/server-threejs
@modelcontextprotocol/server-wiki-explorer
commit: |
49e5adf to
1ce95c5
Compare
|
Made more tweaks beyond what |
ochafik
left a comment
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.
Thanks! Some suggested additions
| npm install | ||
|
|
||
| # Build the SDK (generates schemas + bundles) | ||
| npm run build |
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.
I'd mention there's also build:all to check breakages
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.
That's the next line 😃:
# Build everything (SDK + all examples)
npm run build:all
|
|
||
| # Run unit tests (E2E tests have broader coverage; unit tests cover specific modules) | ||
| npm test | ||
| ``` |
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.
# Regenerate package-lock.json (esp. on setups w/ custom NPM registry)
rm -fR package-lock.json node_modules && \
docker run --rm -it --platform linux/amd64 -v $PWD:/src:rw -w /src node:latest npm i && \
rm -fR node_modules && \
npm i --cache=~/.npm-mcp-apps --registry=https://registry.npmjs.org/
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.
Added!
Provides context about this repository including: - Common commands for building, testing, and running examples - SDK entry points and their purposes - Communication flow between Guest UI, Host, and MCP Server - Key source files and their responsibilities - Protocol lifecycle from initialization to teardown - Type generation workflow Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1ce95c5 to
aa6999b
Compare
Provides context about this repository including:
This was generated via
/initin Claude Code. I think it covers a reasonable amount of information, but if there are pain points you've encountered that aren't covered here, let me know.