github/penpot-mcp
1
0
Fork 0
mirror of https://github.com/penpot/penpot-mcp.git synced 2026-04-25 11:18:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve README

Browse Source
This commit is contained in:
Dominik Jain 2025-10-07 11:44:45 +02:00 committed by Dominik Jain
parent 200c11bb8e
commit 06accf7c45
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -42,7 +42,16 @@ Penpot Plugin API both natural and type-safe.
To use the Penpot MCP server, you must
* run the MCP server and connect your AI client to it,
* run the Penpot MCP plugin in Penpot and connect it to the MCP server.
* run the web server providing the Penpot MCP plugin, and
* open the Penpot MCP plugin in Penpot and connect it to the MCP server.
Follow the steps below to enable the integration.
### Prerequisites
The project requires [Node.js](https://nodejs.org/) (tested with v22).
Following the installation of Node.js, the tools `npm` and `npx` should be
available in your terminal.
### Build & Launch the MCP Server and the Plugin Server
@ -51,7 +60,7 @@ If it's your first execution, install the required dependencies:
npm install
```
Then build all components and start them:
Then build all components and start the two servers:
```shell
npm run bootstrap
```

5
mcp-server/README.md
View File

@ -3,11 +3,6 @@
A Model Context Protocol (MCP) server that provides Penpot integration
capabilities for AI clients supporting the model context protocol (MCP).
## Prerequisites
- Node.js (tested with v22)
- npm (with npx on the PATH)
## Setup
1. Install Dependencies