配置
2025/7/7大约 2 分钟
配置
你可以通过两种方式配置 ECharts 服务,二者的功能相同但键名略有不同。
当你传入了同时传入了合法的 YAML 文件和命令行参数时,所有命令行配置将被忽略。
YAML
YAML 文件对配置的管理更集中,可读性优良。
你可以在任意位置创建服务的 YAML 配置,随后使用 --config-path
命令行参数传入配置文件路径(必要)。
示例配置
示例的 YAML 配置如下 (你也可以在源码的 config.yaml.example
获得):
# MCP 服务器块
server:
transport: http
port: 12345
host: 0.0.0.0
cors:
- "*"
# 资源相关块
resource:
resourcePath: /Path/To/ResourceDir
enabled: true
port: 11223
host: 0.0.0.0
baseUrl: http://localhost:11223
geoJsonPath: /Path/To/GeoJsonDir
logging:
consoleLevel: info
fileLevel: warn
可用项
server
块
键 | 描述 | 默认值 |
---|---|---|
transport | 传输协议,支持 http 和 stdio (或已弃用的 sse ) | stdio |
port | 端口号,MCP 服务监听的端口 | 1122 |
host | 主机地址,MCP 服务监听的主机地址 | 127.0.0.1 |
cors | CORS 允许的来源列表,支持通配符 * 。允许传入列表 / 字符串(指向一个按行分隔的,存储允许的域的文本文件) | 空列表 |
resource
块
键 | 描述 | 默认值 |
---|---|---|
resourcePath | 生成的图表图片存储目录的绝对路径 | ./static |
enabled | 是否启用内置 HTTP 静态托管服务 | true |
port | 内置 HTTP 静态托管服务的端口号 | 1123 |
host | 内置 HTTP 静态托管服务的主机地址 | 127.0.0.1 |
baseUrl | 内置 HTTP 静态托管服务的基础 URL | http://127.0.0.1:1123 |
geoJsonPath | GeoJSON 文件的目录路径 | ./geojson |
logging
块
键 | 描述 | 默认值 |
---|---|---|
consoleLevel | 控制台日志级别,支持 trace , debug , info , warn , error | info |
fileLevel | 文件日志级别,支持 trace , debug , info , warn , error | warn |
命令行参数
你也可以通过命令行参数来配置 ECharts 服务,此处仅给出参数与 YAML 文件键的对应关系。
参数 | YAML 路径 |
---|---|
--transport | server.transport |
--mcp-port | server.port |
--mcp-host | server.host |
--cors | server.cors |
--res-path | resource.resourcePath |
--res-enabled | resource.enabled |
--res-port | resource.port |
--res-host | resource.host |
--res-base-url | resource.baseUrl |
--geojson-path | resource.geoJsonPath |
--log-console | logging.consoleLevel |
--log-file | logging.fileLevel |
(已弃用) 环境变量
出于兼容性考虑,我们保留了应用最初的环境变量配置方式,但已不再增加新的环境变量。未来将移除环境变量配置。
环境变量 | YAML 路径 |
---|---|
MCP_TRANSPORT | server.transport |
MCP_PORT | server.port |
MCP_HOST | server.host |
MCP_CORS | server.cors |
RES_PATH | resource.resourcePath |
RES_ENABLED | resource.enabled |
RES_PORT | resource.port |
RES_HOST | resource.host |
RES_BASE_URL | resource.baseUrl |
GEOJSON_PATH | resource.geoJsonPath |
不支持 | logging.consoleLevel |
不支持 | logging.fileLevel |