Understand GolfMCP project layout and component naming conventions.
golf.json
: The main configuration file (see Configuration).auth.py
: Dedicated authentication configuration file (see Authentication).tools/
: Contains Python files defining your server’s tools (see Component Specification).resources/
: Contains Python files defining data resources the LLM can read (see Component Specification).prompts/
: Contains Python files defining reusable prompt templates (see Component Specification).pre_build.py
is deprecated. Use the dedicated auth.py
file instead for cleaner organization and better maintainability..py
file within tools/
, resources/
, or prompts/
(and their subdirectories) is treated as a single component.__init__.py
are ignored for direct component definition but are essential for Python’s packaging if you structure your components as modules.common.py
are special and used for shared code (see Shared Logic documentation).auth.py
file is treated specially for authentication configuration and is not considered a component.tools
, resources
, prompts
).
Examples:
tools/hello.py
-> ID: hello
tools/payments/transaction/submit.py
-> ID: submit-transaction-payments
resources/weather/current.py
-> ID: current-weather
auth.py
File (New in v0.2.0)auth.py
file for authentication configuration, providing better organization and cleaner separation from other build logic.
Example auth.py
configurations (for full details, see Authentication):