MCP connection
Let your agent read and edit real design elements. The app supports local stdio and Streamable HTTP connections.
Connect an MCP client
- Keep the Proximaforma app running.
- Open Connect agent in the workspace.
- Choose Copy setup instructions and paste them into your agent. Optional Access settings controls scope and expiry.
- The agent chooses its own name and registers. It reads your canvas and comments, then confirms it is ready for instructions.
Registration gives the agent its credential and a Streamable HTTP configuration. It can use REST immediately, or add the MCP server if its client supports that. Otherwise, add the returned configuration in your client’s settings. OAuth-only clients are not yet supported.
Setup links are private, valid for 24 hours, and work once. Fetching the guide does not use the link. If registration succeeds but its response is lost, revoke that connection and create a new link. Local setup links work only for agents on this computer.
Connect over Streamable HTTP
The setup guide tells the agent how to exchange its one-time link and chosen name for a scoped key. Registration returns the complete MCP configuration. For manual client configuration, use the values below. The endpoint uses stateless JSON responses.
Endpoint: http://127.0.0.1:4310/mcp
Transport: Streamable HTTP
Authorization: Bearer YOUR_API_KEYIf you changed the server port, use the endpoint shown in the app. The default server listens only on this computer; remote clients cannot reach it without a separate hosting and authentication setup.
Available tools
| Tool | Purpose |
|---|---|
list_comments | Read feedback and replies, filtered by page or status. |
add_comment | Pin feedback to a page or canvas location. |
reply_to_comment | Reply to a colleague or agent in the same thread. |
update_comment_status | Mark feedback new, in_progress, or handled with its comment revision. |
create_vector_path | Create a custom path with anchors and optional cubic Bézier handles. |
create_vector_shape | Create an editable line, triangle, polygon, or star. |
edit_vector_point | Move, reshape, split, or delete a zero-based path anchor. |
list_projects | List projects and their current revisions. |
get_project | Read a project’s complete element tree and activity. Pass optional elementIds to inspect specific elements and show their names in the agent activity panel. |
create_project | Create a blank project or a sample design. |
add_element | Add an element, optionally inside a frame. |
update_element | Change an element’s position, appearance, text, or parent. |
delete_element | Delete an element and its descendants. |
batch_edit | Apply up to 200 operations as one atomic batch. |
reorder_element | Change an element’s index in the flat element array. |
rename_project | Give a project a new name. |
export_svg | Export the current design as SVG. |
Resources and editing guidance
The server exposes proximaforma://guide and proximaforma://projects/{projectId}. Connected agents also receive design instructions from the server.
- Read the project before editing and pass its latest revision.
- Use
batch_editwith explicit element IDs to add frames and children together. - Keep parent IDs valid. Only frames can contain other elements.
- Inspect the result after a change and refine as needed.
Manage agent access
Each named key is restricted to its owner’s accessible canvases, optionally one canvas, and to read, comment, or design access. Keys expire in 7–90 days and can be revoked. They cannot administer agent keys or invite reviewers.
The stdio bridge uses the local workspace credential by default. For a named agent identity, set PROXIMAFORMA_API_KEY in its environment. Read Your data before connecting a provider.