
Perses
STDIOMCP Server for Perses application interaction via standardized protocol
MCP Server for Perses application interaction via standardized protocol
[!WARNING]
This MCP Server is currently in beta. Features and tools may change, and stability is not guaranteed. Feedback and contributions are most welcome!
The Perses MCP Server is a local Model Context Protocol (MCP) Server that enables the LLM hosts(Claude Desktop, VS Code, Cursor) to interact with the Perses Application in a standardized way.
https://github.com/user-attachments/assets/b80c354a-8006-4e1f-b7f4-e123002f7dc3
PERSES_TOKEN
percli
command line tool:percli login <PERSES_SERVER_URL>
For example, percli login https://demo.perses.dev
.
Or percli login http://localhost:8080
if you are running perses/perses locally from the source code or from the perses image.
percli whoami --show-token
Copy the token to use in your MCP server configuration.
WARNING: Your login will automatically expire in 15 minutes. If you want to extend the token duration, you can change the access_token_ttl
setting in the Perses app configuration, then restart the app (if running locally) or rebuild the Docker image.
Download from Releases
chmod +x /path/to/mcp-server
The Perses MCP Server supports both the transport modes: STDIO mode and Streamable HTTP mode.
In this mode, the MCP server communicates with the LLM host via standard input and output (STDIO).
For more details, see the MCP Protocol Specification docs.
https://github.com/user-attachments/assets/b80c354a-8006-4e1f-b7f4-e123002f7dc3
To add this MCP server to Claude Desktop:
Create or edit the Claude Desktop configuration file at:
~/Library/Application Support/Claude/claude_desktop_config.json
%APPDATA%\Claude\claude_desktop_config.json
~/.config/Claude/claude_desktop_config.json
You can easily access this file via the Claude Desktop app by navigating to Claude > Settings > Developer > Edit Config
.
{ "mcpServers": { "perses-mcp": { "command": "<ABSOLUTE_PATH_TO_PERSES_MCP_BINARY>", "args": [ "--perses-server-url", "<PERSES_SERVER_URL>" // Add "--read-only" here for read-only mode ], "env": { "PERSES_TOKEN": "<PERSES_TOKEN>" } } } }
Add the following JSON code snippet to the VS Code MCP Config file. See VS Code MCP documentation for more details.
{ "inputs": [ { "type": "promptString", "id": "perses-token", "description": "PERSES_TOKEN to connect with Perses Application", "password": true } ], "servers": { "perses-mcp": { "command": "<ABSOLUTE_PATH_TO_PERSES_MCP_BINARY>", "args": [ "--perses-server-url", "http://localhost:8080" // Add "--read-only" here for read-only mode ], "env": { "PERSES_TOKEN": "${input:perses-token}" } } } }
The Streamable HTTP mode allows the MCP server to communicate with LLM hosts over HTTP, similar to a regular web API. This mode is particularly useful for:
For more details, see the MCP Protocol Specification Docs.
Before starting the MCP server, set your Perses authentication token:
export PERSES_TOKEN=<YOUR_PERSES_TOKEN>
Run the following command to start the MCP server in Streamable HTTP mode:
/path/to/mcp-server --transport streamable-http --perses-server-url <PERSES_SERVER_URL> --port 8000
{ "servers": { "perses-http": { "type": "http", "url": "http://localhost:<port>/mcp" } } }
The Perses MCP Server supports several command-line flags to customize its behavior:
Flag | Default | Description |
---|---|---|
--perses-server-url | http://localhost:8080 | The Perses backend server URL |
--log-level | info | Log level (options: debug , info , warn , error ) |
--transport | stdio | MCP protocol transport mechanism (options: stdio , streamable-http ) |
--port | 8000 | Port to run the HTTP Streamable server on (only used with streamable-http transport) |
--read-only | false | Restrict the server to read-only operations |
If you want to build the MCP server from source code (for development or contribution purposes), run the following command from the source code root directory:
make build
This should create a bin
directory which contains the binary named mcp-server
. Copy the absolute path to the binary to use in your MCP server configuration.
[!NOTE]
When running in read-only mode (--read-only
flag), only tools that retrieve information are available. Write operations likecreate_project
,create_dashboard
,create_global_datasource
,update_global_datasource
, andcreate_project_variable
are disabled in read-only mode.
Tool | Description | Required Parameters |
---|---|---|
perses_list_projects | List all projects | - |
perses_get_project_by_name | Get a project by name | project |
perses_create_project | Create a new project | project |
Tool | Description | Required Parameters |
---|---|---|
perses_list_dashboards | List all dashboards for a specific project | project |
perses_get_dashboard_by_name | Get a dashboard by name for a project | project , dashboard |
perses_create_dashboard | Create a dashboard given a project and dashboard configuration | project , dashboard |
For dashboard configuration, see Perses Dashboards
Tool | Description | Required Parameters | Optional Parameters |
---|---|---|---|
perses_list_global_datasources | List all global datasources | - | - |
perses_list_datasources | List all datasources for a specific project | project | - |
perses_get_global_datasource_by_name | Get a global datasource by name | datasource | - |
perses_get_project_datasource_by_name | Get a project datasource by name | project , datasource | - |
perses_create_global_datasource | Create a new global datasource | name , type , url | display_name , proxy_type |
perses_update_global_datasource | Update an existing global datasource | name , type , url | display_name , proxy_type |
Tool | Description | Required Parameters |
---|---|---|
perses_list_global_roles | List all global roles | - |
perses_get_global_role_by_name | Get a global role by name | role |
perses_list_global_role_bindings | List all global role bindings | - |
perses_get_global_role_binding_by_name | Get a global role binding by name | roleBinding |
perses_list_project_roles | List all roles for a specific project | project |
perses_get_project_role_by_name | Get a project role by name | project , role |
perses_list_project_role_bindings | List all role bindings for a project | project |
perses_get_project_role_binding_by_name | Get a project role binding by name | project , roleBinding |
Tool | Description | Required Parameters |
---|---|---|
perses_list_plugins | List all plugins | - |
Tool | Description | Required Parameters |
---|---|---|
perses_list_global_variables | List all global variables | - |
perses_get_global_variable_by_name | Get a global variable by name | variable |
perses_list_variables | List all variables for a specific project | project |
perses_get_project_variable_by_name | Get a project variable by name | project , variable |
perses_create_project_variable | Create a project level variable | name , project |
The code is licensed under an Apache 2.0 license.