API Reference / @gtkx/config / @gtkx/config / McpOptions

Type Alias: McpOptions

McpOptions = object

Defined in: packages/config/src/config.ts:229

The mcp options: the tools gtkx mcp offers by default and whether it may interact with the app.

Properties

readOnly?

optional readOnly?: boolean

Defined in: packages/config/src/config.ts:248

Whether the MCP server exposes only inspection and reference tools, excluding app interactions. gtkx mcp --read-only overrides it.

Default Value

false

---

tools?

optional tools?: string[]

Defined in: packages/config/src/config.ts:241

Tool name patterns applied in order: * matches any text and a leading ! excludes matches. Omitted, empty, or exclusion-only lists start with all tools; other lists start with none. gtkx mcp --tools overrides it.

Default Value

[]: every tool

Example

tools: ["gtkx_*", "!gtkx_take_screenshot"],