Add MCP server (#569)

Author: ericglau

.changeset/petite-signs-spend.md

@@ -0,0 +1,9 @@
+---
+'@openzeppelin/wizard-cairo': minor
+'@openzeppelin/wizard-stellar': patch
+'@openzeppelin/wizard-stylus': patch
+'@openzeppelin/wizard-common': patch
+'@openzeppelin/wizard-mcp': patch
+---
+
+Add support for Wizard MCP server.

.changeset/solidity-signs-spend.md

@@ -0,0 +1,7 @@
+---
+'@openzeppelin/wizard': minor
+---
+
+Add support for Wizard MCP server.
+- **Possibly breaking changes**:
+  - `Governor`: Remove usage of `access` option. This option now has no effect.

CONTRIBUTING.md

@@ -5,7 +5,9 @@ Contributions to OpenZeppelin Contracts Wizard are welcome. Please review the in
 
 ## Project layout
 
+- `packages/common` contains common code used internally by some of the below packages.
 - `packages/core` contains the code generation logic for each language under separately named subfolders.
+- `packages/mcp` contains the MCP server.
 - `packages/ui` is the interface built in Svelte.
 
 ## Building and testing the project
@@ -65,6 +67,29 @@ Then from the `packages/ui` directory:
 > [!TIP]
 > You can also start both the UI and API servers simultaneously by running `yarn dev` from the root directory.
 
+### Testing the MCP server (Optional)
+
+#### Running MCP tests
+From the `packages/mcp` directory:
+- ```yarn test```
+
+#### Running the local MCP server in your IDE
+1. From the `packages/mcp` directory, run `yarn watch` to compile and watch for changes.
+2. Configure your IDE's MCP configuration file with the following, replacing `<ABSOLUTE_PATH_TO_WIZARD_PROJECT_ROOT>` with the absolute path to the root directory of this repository:
+```
+{
+  "mcpServers": {
+    "openzeppelin-contracts-wizard": {
+      "command": "node",
+      "args": [
+        "<ABSOLUTE_PATH_TO_WIZARD_PROJECT_ROOT>/packages/mcp/dist/index.js"
+      ]
+    }
+  }
+}
+```
+3. When you make changes to the MCP server's code, refresh the MCP server in your IDE to pick up the changes.
+
 ## Creating Pull Requests (PRs)
 
 As a contributor, we ask that you fork this repository, work on your own fork and then submit pull requests. The pull requests will be reviewed and eventually merged into the main repo. See ["Fork-a-Repo"](https://help.github.com/articles/fork-a-repo/) for how this works.

README.md

@@ -14,6 +14,10 @@ Contracts Wizard is a web application to interactively build a contract out of c
 
 Use the Contracts Wizard at https://wizard.openzeppelin.com/
 
+## MCP Server
+
+The [MCP server](packages/mcp/README.md) allows AI agents to generate smart contracts using the Contracts Wizard.
+
 ## TypeScript API
 
 You can use the programmatic TypeScript API to generate contracts from your own applications.

package.json

@@ -3,7 +3,7 @@
   "private": true,
   "type": "module",
   "scripts": {
-    "prepare": "wsrun -m prepare",
+    "prepare": "yarn workspaces run prepare",
     "lint": "eslint",
     "format:write": "prettier --write \"**/*\"",
     "format:check": "prettier --check \"**/*\"",
@@ -17,7 +17,9 @@
   },
   "workspaces": {
     "packages": [
+      "packages/common",
       "packages/core/*",
+      "packages/mcp",
       "packages/ui"
     ],
     "nohoist": [
@@ -36,7 +38,6 @@
     "prettier-plugin-svelte": "^3.3.3",
     "typescript": "^5.7.3",
     "typescript-eslint": "^8.29.0",
-    "wsrun": "^5.2.4",
     "@changesets/cli": "^2.29.2",
     "@changesets/changelog-github": "^0.5.1"
   }

packages/common/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog