Skip to main content

Fields

name

Required. Server display name.

description

Optional description shown in the UI.

icon

Optional path to icon image (relative to project root).

auth

Authentication configuration.
string
required
One of: oauth, cred, none
  • oauth — Users authorize via OAuth flow
  • cred — Users enter credentials in UI
  • none — Developer provides via env vars
array
For type: cred only. Credential fields shown to users.Each credential has:
  • name — Key returned by get_credentials()
  • label — Display label in UI
  • description — Help text
  • placeholder — Input placeholder
  • secret — Mask input (default: false)
  • required — Required field (default: true)

tools

Required. List of tools exposed by the server.
string
required
Function name in server.py. Must match exactly.
string
required
Tool description for users and LLMs.

Example: OAuth server

Example: API key server

Example: No auth server