> ## Documentation Index
> Fetch the complete documentation index at: https://docs.5ire.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Server 一键安装接入指南

在 `v0.10.2` 后，5ire 支持通过以下协议触发工具安装。

```
app.5ire://install-tool#{base64格式的server配置}
```

例如

```
app.5ire://install-tool#ewogICJuYW1lIjogImlwLXF1ZXJ5IiwKICAidXJsIjogImh0dHBzOi8vbWNwLmhpZ3Jlc3MuYWkvbWNwLWlwLXF1ZXJ5L2Zkc2ZkazQzMjQyM2JhMmZkc2EiCn0=
```

### Server 配置格式

Server 配置必须包含的内容有

1. name
   * 仅包含大小写字母、连字符和数字
   * 长度大于1
   * 不能以数字开头，连字符结尾)
2. url 或者 command (二选一)

可选的内容有

1. args
2. env
3. headers

**示例**

```JSON theme={null}
{
  "name": "ip-query",
  "url": "https://mcp.higress.ai/mcp-ip-query/fdsfdk432423ba2fdsa",
}
```

```JSON theme={null}
{
  "name": "Blender",
  "description": "a blender mcp server enables prompt assisted 3D modeling, scene creation, and manipulation",
  "command": "uvx",
  "args": [
    "blender-mcp"
  ]
}
```

### 变量

若 Server 需要用户填入参数，请遵守以下的约定

```JSON theme={null}
{{paramName@paramType::paramDescription}}
```

该约定允许应用程序提取出需要自定义的参数，以合适的交互方式供用户填写。

例如

```JSON theme={null}
{
    "name": "file-system",
    "command": "npx",
    "description": "The server will only allow operations within directories specified via args.",
    "args": [
      "-y",
      "@modelcontextprotocol/server-filesystem",
      "{{dirs@list::directories you about to access. Trailing slash in path required.}}"
    ],
    "homepage":"https://github.com/modelcontextprotocol/servers"
  }
```

该配置将提取出如下参数供 5ire 在交互界面提供用户输入表单。

```JSON theme={null}
{
  "name":"dirs",
  "type":"list",
  "description": "directories you about to access. Trailing slash in path required."
}
```

* paramName 在当前 server 内必须唯一，由大小写字母和数字组成，且不能以数字开头
* paramType 目前支持 string, list 和 number, 请确保使用正确的类型
* description 可选