Configuration reference

The golf.json file is the main configuration file for your Golf project. Place this file in your project root directory to configure your MCP server.

string

required

The name of your MCP server instance.

{
  "name": "MyProject"
}

string

A brief description of your Golf project.

{
  "description": "A GolfMCP project"
}

string

default:"localhost"

The network interface the server will bind to.

{
  "host": "localhost"
}

integer

default:"3000"

The port number the server will listen on.

{
  "port": 3000
}

string

default:"sse"

The transport protocol for client-server communication.Options:

"sse" - Server-Sent Events
"streamable-http" - HTTP with streaming support
"stdio" - Standard input/output

{
  "transport": "sse"
}

boolean

default:"false"

Enable OpenTelemetry distributed tracing for your MCP server. For detailed configuration and features, see Telemetry.

{
  "opentelemetry_enabled": true
}

string

default:"otlp_http"

The default exporter to use for OpenTelemetry traces when enabled.Options:

"otlp_http" - OTLP HTTP exporter (for Jaeger, Grafana Tempo, etc.)
"console" - Console exporter (for debugging)

{
  "opentelemetry_default_exporter": "otlp_http"
}

When using otlp_http, you must set the OTEL_EXPORTER_OTLP_ENDPOINT environment variable. See the environment variables section below.

Health check configuration (deprecated)

The following health check configuration options are deprecated as of v0.2.11. Use custom health.py and readiness.py files instead for modern, flexible health checks with Kubernetes compatibility. See Telemetry & Monitoring for the new approach.

boolean

default:"false"

Deprecated: Enable basic health check endpoint. Use custom health.py file instead.

{
  "health_check_enabled": true
}

string

default:"/health"

Deprecated: Health check endpoint path. Custom health.py files automatically create /health endpoint.

{
  "health_check_path": "/health"
}

string

default:"OK"

Deprecated: Static health check response text. Use custom health.py for dynamic responses with proper status codes.

{
  "health_check_response": "Service is healthy"
}

Getting started

Core concepts

Authentication

Advanced features

Reference

Health check configuration (deprecated)

​Health check configuration (deprecated)

Health check configuration (deprecated)