Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help


MCP 配置参考手册

本页面是主 MCP 文档的简明配套参考资料。

如需概念性指导,请参阅:

根级配置结构

mcp_servers:
  <server_name>:
    command: "..."      # stdio servers
    args: []
    env: {}

    # OR
    url: "..."          # HTTP servers
    headers: {}

    # Optional HTTP/SSE TLS settings:
    ssl_verify: true                # bool or path to a CA bundle (PEM)
    client_cert: "/path/to/cert.pem"  # mTLS client certificate (see below)
    # client_key: "/path/to/key.pem"  # optional, when key lives in a separate file

    enabled: true
    timeout: 120
    connect_timeout: 60
    supports_parallel_tool_calls: false
    tools:
      include: []
      exclude: []
      resources: true
      prompts: true

服务器密钥

键名类型适用场景含义
command字符串stdio需要启动的可执行程序
args列表stdio子进程的参数
env映射对象stdio传递给子进程的环境变量
url字符串HTTP远程 MCP 接口地址
headers映射对象HTTP发送至远程服务器请求时的请求头
ssl_verify布尔值或字符串HTTPTLS 验证设置。true(默认值)表示使用系统证书颁发机构;false 表示禁用验证(不安全);也可以是自定义 CA 包(PEM 格式)的路径
client_cert字符串或列表HTTPmTLS 客户端证书。字符串形式表示包含证书和密钥的 PEM 文件路径;列表 [cert, key] 表示证书和密钥为独立文件;列表 [cert, key, password] 表示密钥已加密
client_key字符串HTTPclient_cert 为字符串且密钥存储在单独文件中时,该字段用于指定客户端私钥的路径
enabled布尔值两者均适用当该值为 false 时,完全跳过该服务器
timeout数字两者均适用工具调用的超时时间(以秒为单位,默认值为 300
connect_timeout数字两者均适用初始连接的超时时间(以秒为单位,默认值为 60
supports_parallel_tool_calls布尔值两者均适用是否允许来自该服务器的工具并行运行
skip_preflight布尔值HTTP对于那些 HEAD/GET 请求返回非 MCP 类型内容的有效 Streamable HTTP 接口,跳过快速失败的 Content-Type 探测(默认值为 false
tools映射对象两者均适用用于过滤工具以及定义实用工具的相关策略
auth字符串HTTP认证方式。设置为 oauth 可启用带 PKCE 的 OAuth 2.1 认证
sampling映射对象两者均适用由服务器发起的 LLM 请求策略(详见 MCP 指南)

tools 策略键

键名类型含义
include字符串或列表白名单机制,用于指定允许使用的服务器原生 MCP 工具
exclude字符串或列表黑名单机制,用于指定禁止使用的服务器原生 MCP 工具
resources类布尔值控制是否启用 list_resourcesread_resource 功能
prompts类布尔值控制是否启用 list_promptsget_prompt 功能

过滤规则说明

include 参数

如果设置了 include 参数,那么只会注册那些属于服务器原生的 MCP 工具。

tools:
  include: [create_issue, list_issues]

exclude

如果设置了 exclude 而未设置 include,则除了列出的工具名称之外,所有原生服务器 MCP 工具都会被注册。

tools:
  exclude: [delete_customer]

优先级规则

当两者同时被设置时,include 的优先级更高。

tools:
  include: [create_issue]
  exclude: [create_issue, delete_issue]

结果:

  • create_issue 功能仍然可用
  • 由于 include 的优先级更高,delete_issue 被忽略

工具类插件策略

Hermes 可以根据每个 MCP 服务器注册相应的工具封装插件:

资源操作:

  • list_resources
  • read_resource

提示词相关操作:

  • list_prompts
  • get_prompt

禁用资源操作

tools:
  resources: false

禁用提示词功能

tools:
  prompts: false

基于能力识别的注册机制

即便设置了 resources: trueprompts: true,只要 MCP 会话并未实际提供相应的能力,Hermes 也不会注册那些工具功能。

因此出现以下情况属于正常现象:

  • 您启用了提示功能
  • 但并未看到任何提示相关的工具
  • 原因是服务器不支持该功能

enabled: false

mcp_servers:
  legacy:
    url: "https://mcp.legacy.internal"
    enabled: false

行为表现:

  • 不尝试建立连接
  • 不进行服务器发现
  • 不注册任何工具
  • 配置将保留以便日后重复使用

无结果时的处理方式

如果过滤操作移除了所有服务器原生工具,且也未注册任何实用工具,Hermes 将不会为该服务器创建空的 MCP 运行时工具集。

配置示例

安全的 GitHub 允许列表

mcp_servers:
  github:
    command: "npx"
    args: ["-y", "@modelcontextprotocol/server-github"]
    env:
      GITHUB_PERSONAL_ACCESS_TOKEN: "***"
    tools:
      include: [list_issues, create_issue, update_issue, search_code]
      resources: false
      prompts: false

Stripe 黑名单

mcp_servers:
  stripe:
    url: "https://mcp.stripe.com"
    headers:
      Authorization: "Bearer ***"
    tools:
      exclude: [delete_customer, refund_payment]

仅资源型文档服务器

mcp_servers:
  docs:
    url: "https://mcp.docs.example.com"
    tools:
      include: []
      resources: true
      prompts: false

TLS 客户端证书(mTLS)

对于需要客户端证书的 HTTP/SSE 服务器,请设置 client_cert(可选地也可设置 client_key):

mcp_servers:
  # Combined cert + key in a single PEM file
  internal_api:
    url: "https://mcp.internal.example.com/mcp"
    client_cert: "~/secrets/mcp-client.pem"

  # Separate cert and key files
  partner_api:
    url: "https://mcp.partner.example.com/mcp"
    client_cert: "~/secrets/client.crt"
    client_key: "~/secrets/client.key"

  # Encrypted key with a passphrase (3-element list form)
  bank_api:
    url: "https://mcp.bank.example.com/mcp"
    client_cert: ["~/secrets/client.crt", "~/secrets/client.key", "my-passphrase"]

  # Custom CA bundle (private CA / self-signed server)
  lab_api:
    url: "https://mcp.lab.local/mcp"
    ssl_verify: "~/secrets/lab-ca.pem"
    client_cert: "~/secrets/lab-client.pem"

备注:

  • 路径支持使用 ~ 进行扩展。若文件不存在,连接服务器时将会立即失败,并显示与服务器相关的错误信息。
  • ssl_verify: false 会完全禁用对服务器证书的验证。请勿在真实服务中使用此选项。
  • 该功能同时支持 Streamable HTTP 和 SSE 传输方式。

重新加载配置

修改 MCP 配置后,可通过以下命令重新加载服务器:

/reload-mcp

工具命名规则

服务器原生的 MCP 工具将被命名为:

mcp_<server>_<tool>

示例:

  • mcp_github_create_issue
  • mcp_filesystem_read_file
  • mcp_my_api_query_data

实用工具也遵循相同的命名前缀规则:

  • mcp_<服务器名>_list_resources
  • mcp_<服务器名>_read_resource
  • mcp_<服务器名>_list_prompts
  • mcp_<服务器名>_get_prompt

名称规范化处理

在注册之前,服务器名称和工具名称中的连字符(-)及点号(.)都会被替换为下划线。这样做可确保工具名称能够作为有效的标识符,用于调用大型语言模型相关接口。

例如,一个名为 my-api 的服务器若提供了名为 list-items.v2 的工具,其名称将会被调整为:

mcp_my_api_list_items_v2

在编写 include / exclude 过滤规则时,请牢记这一点:应使用 原始的 MCP 工具名称(包含连字符/点号),而非经过清理后的版本。

OAuth 2.1 身份验证

对于需要 OAuth 认证的 HTTP 服务器,需在服务器配置项中设置 auth: oauth

mcp_servers:
  protected_api:
    url: "https://mcp.example.com/mcp"
    auth: oauth

行为特性:

  • Hermes采用MCP SDK的OAuth 2.1 PKCE流程(包括元数据发现、动态客户端注册、令牌交换及刷新功能);
  • 首次连接时,系统会打开一个浏览器窗口以进行授权;
  • 令牌会被保存在~/.hermes/mcp-tokens/<服务器名>.json文件中,并可在不同会话间重复使用;
  • 令牌刷新为自动处理,仅当刷新失败时才会要求重新授权;
  • 此功能仅适用于HTTP/StreamableHTTP传输方式(基于url的服务器)。