Skip to content

Conversation

@MiguelsPizza
Copy link
Contributor

  • Add centered header with badges and navigation links
  • Remove all emojis throughout the document
  • Reorganize sections with clear hierarchy
  • Add comprehensive "What This Does" section
  • Improve "Quick Start" with installation instructions
  • Enhance "Examples" section with better structure
  • Add "Architecture" section with API comparison
  • Standardize "Documentation", "Resources", and "Contributing" sections
  • Follow professional open-source README best practices

Description

Type of Change

  • New example
  • Bug fix in existing example
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Dependency update

Related Issues

Fixes #
Related to #

Changes Made

  • Change 1
  • Change 2
  • Change 3

New Example Details

  • Example name:
  • Framework: [e.g., vanilla TypeScript, React, Vue]
  • WebMCP concepts demonstrated:
  • Tools registered:
  • Dependencies added:

Testing

Commands Run

cd [example-directory]
pnpm install     # ✓ Installed successfully
pnpm typecheck   # ✓ Passed
pnpm lint        # ✓ Passed
pnpm build       # ✓ Passed
pnpm dev         # ✓ Runs without errors

Manual Testing with MCP-B Extension

  • Extension detects the page
  • All registered tools appear in extension
  • Each tool executes successfully
  • UI updates correctly after tool execution
  • Error cases handled gracefully
  • Tested in Chrome/Edge
  • Tested on mobile (if applicable)

Screenshot/Demo

Checklist

  • My code follows the style guidelines in CONTRIBUTING.md
  • I have used the modern WebMCP API (@mcp-b/global or @mcp-b/react-webmcp)
  • I have NOT used deprecated APIs from /relegated
  • I have performed a self-review of my own code
  • I have added JSDoc comments to all exported functions/components
  • I have created/updated README.md for the example
  • My changes generate no TypeScript errors
  • I have tested with the MCP-B Chrome Extension
  • All tools register and execute successfully
  • Example runs without console errors

Documentation

  • README.md includes clear description of what the example demonstrates
  • README.md has installation and usage instructions
  • README.md explains WebMCP concepts used
  • Code has explanatory comments for WebMCP-specific code
  • Dependencies are documented in package.json

Additional Notes


For AI Agents: Please verify all items in the checklist before submitting. Run all commands listed in the Testing section.

- Add centered header with badges and navigation links
- Remove all emojis throughout the document
- Reorganize sections with clear hierarchy
- Add comprehensive "What This Does" section
- Improve "Quick Start" with installation instructions
- Enhance "Examples" section with better structure
- Add "Architecture" section with API comparison
- Standardize "Documentation", "Resources", and "Contributing" sections
- Follow professional open-source README best practices
- Add vite-env.d.ts to both vanilla and react examples to fix CSS import type errors
- Add typecheck script (tsc --noEmit) to both package.json files
- Add lint script (tsc --noEmit) to both package.json files
- All CI checks now pass: lint, typecheck, and build for both examples
- Remove pnpm-lock.yaml from .gitignore
- Add vanilla/pnpm-lock.yaml and react/pnpm-lock.yaml to git
- This fixes the CI cache setup error: "Some specified paths were not resolved"
- Lock files ensure reproducible builds across environments
@MiguelsPizza MiguelsPizza merged commit 9b6ec86 into main Nov 5, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants