Skip to main content
name: "my-server"
description: "Optional description"
icon: "assets/icon.png"

auth:
  type: oauth | cred | none
  credentials:  # For type: cred only
    - name: "api_key"
      label: "API Key"
      description: "Your API key from the dashboard"
      placeholder: "sk-..."
      secret: true
      required: true

tools:
  - name: "tool_function_name"
    description: "What the tool does"

​
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.
​
type
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
​
credentials
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.
​
name
string
required
Function name in server.py. Must match exactly.
​
description
string
required
Tool description for users and LLMs.

​
Example: OAuth server

name: "linear-mcp"
description: "Linear integration for issue tracking"

auth:
  type: oauth

tools:
  - name: "list_issues"
    description: "List issues in a project"
  - name: "create_issue"
    description: "Create a new issue"
  - name: "update_issue"
    description: "Update an existing issue"

​
Example: API key server

name: "openai-mcp"
description: "OpenAI API wrapper"

auth:
  type: cred
  credentials:
    - name: "api_key"
      label: "OpenAI API Key"
      placeholder: "sk-..."
      secret: true

tools:
  - name: "generate"
    description: "Generate text with GPT"

​
Example: No auth server

name: "weather-mcp"
description: "Weather data API"

auth:
  type: none

tools:
  - name: "get_weather"
    description: "Get current weather for a city"