Skip to content

toolsets.md

Latest commit

 

History

History
45 lines (36 loc) · 2.79 KB

toolsets.md

File metadata and controls

45 lines (36 loc) · 2.79 KB
Raw

Dynamic Setting for Toolsets

In dynamic settings you can include toolsets and their parameters you wish to enable in DIAL.

toolsets

A list of deployed DIAL Toolsets and their parameters:

  • <toolset_name> is an unique toolset name.

toolsets.<toolset_name>

An object containing parameters for each toolset.

  • endpoint: DIAL Toolset API for MCP calls.
  • iconUrl: A string with the URL with the icon location to display for the toolset on UI.
  • description: A brief DIAL toolset description.
  • intro: A string with a short introductory/onboarding text for the toolset, shown to end users separately from description.
  • displayName: A string with the toolset's name. Display name is shown in all DIAL client UI dropdowns, tables, and logs so operators can quickly identify the toolset.
  • userRoles: A specific claim value provided by a specific IDP in JWT or an API key role. If not defined, the toolset is available to all users. Refer to IDP Configuration to view examples.
  • descriptionKeywords: A list of keywords describes the toolset, e.g. code-gen, text2image.
  • maxRetryAttempts: A max retry attempts to route a single user request to the toolset's endpoint.
  • author: The toolset's developer.
  • createdAt: The date of the toolset creation.
  • updatedAt: The date of the last toolset update.
  • transport: A transport supported by MCP server. The available options are: HTTP or SSE.
  • allowedTools: A list of available tools in the MCP server.
  • forwardPerRequestKey: Set this flag to true if you want a per request API key to be forwarded to the toolset endpoint allowing a toolset to access files in the DIAL storage. Note: it is not allowed to creaete toolsets with authType.API_KEY and forwardPerRequestKey=true.
  • forwardAuthToken: A boolean parameter to determine whether the authorization token should be forwarded from the caller's session to the upstream API call. This enables multi-tenant scenarios or pass-through authentication for downstream services. If this flag is set to true, the Http header with authorization token is forwarded to the chat completion endpoint of the toolset.
  • provider: A vendor's name
  • vendorWebsite: A vendor's (external provider/partner's) website

Example:

"toolsets": {
        "git": {
            "transport": "http",
            "endpoint": "http://git-mcp-server/call",
            "allowed_tools": ["branch", "remote"],
            "description": "Git remote tool set",
            "intro": "Browse and manage git remotes and branches"
        }
    },