diff --git a/.changeset/proud-horses-scream.md b/.changeset/proud-horses-scream.md new file mode 100644 index 00000000..959e691a --- /dev/null +++ b/.changeset/proud-horses-scream.md @@ -0,0 +1,6 @@ +--- +'quickmock': patch +'@lemoncode/quickmock-mcp': patch +--- + +Added basic README.md. diff --git a/README.md b/README.md index 3c3f9cf3..0ac8d160 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,10 @@ npm run dev Open your browser and go to http://localhost:5173 (if this port is busy it will be changed to the next available port) +## VS Code extension + +If you prefer to work inside VS Code, install the [QuickMock VS Code extension](./packages/vscode-extension/README.md). It adds a custom editor for `.qm` files and also configures the MCP server for AI tools. + ## 🤝 Contributing Your feedback and contributions are welcome! If you have ideas for new features or have found a bug, we would love to hear about it. Here's how you can contribute: diff --git a/packages/mcp/README.md b/packages/mcp/README.md new file mode 100644 index 00000000..1691993d --- /dev/null +++ b/packages/mcp/README.md @@ -0,0 +1,141 @@ +# QuickMock MCP Server + + + + + + + +## 🌟 Project + +`@lemoncode/quickmock-mcp` is the MCP server for QuickMock. + +It provides tools to inspect `.qm` wireframe files, read their content and pages, extract image assets, and generate rendered screenshots through a headless browser flow. + +### Available tools + +- `list_wireframes`: finds `.qm` files in the current workspace. +- `get_wireframe_json`: returns JSON content from a wireframe file. +- `get_wireframe_pages`: returns wireframe pages metadata. +- `get_wireframe_assets`: extracts embedded image assets to disk. +- `capture_wireframe`: renders and returns a PNG screenshot. + +## 🚀 Installation + +To work on this package locally from the monorepo: + +```sh +git clone https://github.com/Lemoncode/quickmock.git +cd quickmock +npm install +``` + +Build the MCP package: + +```bash +npm run build --workspace packages/mcp +``` + +Run it via stdio: + +```bash +npx -y @lemoncode/quickmock-mcp +``` + +Inspect it with MCP Inspector: + +```bash +npm run inspect --workspace packages/mcp +``` + +## 🤝 Contributing + +Your feedback and contributions are welcome. If you find issues related to MCP tool behavior, wireframe parsing, or rendering output, please open an issue with reproduction steps and environment details. + +## 🛠️ Technologies + +The package is developed with: + +- [TypeScript](https://www.typescriptlang.org/) +- [Model Context Protocol SDK](https://github.com/modelcontextprotocol/typescript-sdk) +- [Puppeteer Core](https://pptr.dev/) +- [Zod](https://zod.dev/) +- [Vitest](https://vitest.dev/) + +## 👥 Team + +Team members participating in this project: + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+