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

Move multi-user mode documentation to a separate file

Browse Source
This commit is contained in:
Dominik Jain 2026-01-12 12:40:13 +01:00
parent 922eeb579f
commit 914903ed84
2 changed files with 46 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -190,43 +190,9 @@ This repository is a monorepo containing four main components:
The core components are written in TypeScript, rendering interactions with the The core components are written in TypeScript, rendering interactions with the
Penpot Plugin API both natural and type-safe. Penpot Plugin API both natural and type-safe.
## Multi-User Mode ## Beyond Local Execution
The Penpot MCP server supports a multi-user mode, allowing multiple Penpot users The above instructions describe how to run the MCP server and plugin server locally.
to connect to the same MCP server instance simultaneously. We are working on enabling remote deployments of the MCP server, particularly
This supports remote deployments of the MCP server, without requiring each user in [multi-user mode](docs/multi-user-mode.md), where multiple Penpot users will
to run their own server instance. be able to connect to the same MCP server instance.
> [!WARNING]
> Multi-user mode is currently experimental.
### Limitations
Multi-user mode has the limitation that tools which read from or write to
the local file system are not supported, as the server cannot access
the client's file system. This affects the import and export tools.
### Running Components in Multi-User Mode
To run the MCP server and the Penpot MCP plugin in multi-user mode (for testing),
you can use the following command:
```shell
npm run bootstrap:multi-user
```
This will:
* launch the MCP server in multi-user mode (adding the `--multi-user` flag),
* build and launch the Penpot MCP plugin server in multi-user mode.
See the package.json scripts for both `mcp-server` and `penpot-plugin` for details.
In multi-user mode, users are required to be authenticated via a token.
* This token is provided in the URL used to connect to the MCP server,
e.g. `http://localhost:4401/mcp?userToken=USER_TOKEN`.
* The same token must be provided when connecting the Penpot MCP plugin
to the MCP server.
In the future, the token will, most likely be generated by Penpot and
provided to the plugin automatically.
For now, it is hard-coded in the plugin's source code for testing purposes.

41
docs/multi-user-mode.md Normal file
View File

@ -0,0 +1,41 @@
# Multi-User Mode
> [!WARNING]
> Multi-user mode is under development and not yet fully integrated.
> This information is provided for testing purposes only.
The Penpot MCP server supports a multi-user mode, allowing multiple Penpot users
to connect to the same MCP server instance simultaneously.
This supports remote deployments of the MCP server, without requiring each user
to run their own server instance.
## Limitations
Multi-user mode has the limitation that tools which read from or write to
the local file system are not supported, as the server cannot access
the client's file system. This affects the import and export tools.
## Running Components in Multi-User Mode
To run the MCP server and the Penpot MCP plugin in multi-user mode (for testing),
you can use the following command:
```shell
npm run bootstrap:multi-user
```
This will:
* launch the MCP server in multi-user mode (adding the `--multi-user` flag),
* build and launch the Penpot MCP plugin server in multi-user mode.
See the package.json scripts for both `mcp-server` and `penpot-plugin` for details.
In multi-user mode, users are required to be authenticated via a token.
* This token is provided in the URL used to connect to the MCP server,
e.g. `http://localhost:4401/mcp?userToken=USER_TOKEN`.
* The same token must be provided when connecting the Penpot MCP plugin
to the MCP server.
In the future, the token will, most likely be generated by Penpot and
provided to the plugin automatically.
:warning: For now, it is hard-coded in the plugin's source code for testing purposes.