-
Notifications
You must be signed in to change notification settings - Fork 349
One‐Click Server Installation Integration Guide
Ironben edited this page May 19, 2025
·
2 revisions
One-Click.Server.Installation.mp4
Starting from v0.10.2, 5ire supports triggering tool installations via the following protocol:
app.5ire://install-tool#{base64-encoded_server_configuration}
Example:
app.5ire://install-tool#ewogICJuYW1lIjogImlwLXF1ZXJ5IiwKICAidXJsIjogImh0dHBzOi8vbWNwLmhpZ3Jlc3MuYWkvbWNwLWlwLXF1ZXJ5L2Zkc2ZkazQzMjQyM2JhMmZkc2EiCn0=
A valid server configuration must include:
-
name
:- Contains only letters, hyphens, and numbers.
- Length > 1.
- Cannot start with a number or end with a hyphen.
-
Either
url
orcommand
(choose one).
Optional fields:
args
env
headers
Examples:
{
"name": "ip-query",
"url": "https://mcp.higress.ai/mcp-ip-query/fdsfdk432423ba2fdsa"
}
{
"name": "Blender",
"description": "A Blender MCP server enabling prompt-assisted 3D modeling, scene creation, and manipulation",
"command": "uvx",
"args": ["blender-mcp"]
}
If your server requires user-provided parameters, use the following syntax in configuration fields (e.g., args
, env
, headers
):
{{paramName@paramType::paramDescription}}
This syntax allows the application to identify parameters requiring user input and present appropriate interactive forms.
Example:
{
"name": "file-system",
"command": "npx",
"description": "The server restricts operations to specified directories.",
"args": [
"-y",
"@modelcontextprotocol/server-filesystem",
"{{dirs@list::Directories to access (trailing slash required).}}"
],
"homepage": "https://github.com/modelcontextprotocol/servers"
}
This configuration would generate the following parameter prompt:
{
"name": "dirs",
"type": "list",
"description": "Directories to access (trailing slash required)."
}
Rules:
-
paramName
: Must be unique within the configuration, using only letters and numbers. Cannot start with a number. -
paramType
: Supported types:string
,list
,number
. -
description
: Optional.