FilesExpand file tree

main

/

config.example.yaml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

95 lines (86 loc) · 4.28 KB

main

/

config.example.yaml

Copy path

Top

File metadata and controls

• Code
• Blame

95 lines (86 loc) · 4.28 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

schema_version: 1

app:

profile: bridge

server:

display_name: Demo MCP Bridge Server

transport: streamable_http

endpoint: https://demo.invalid/mcp

# MCP protocol revision: auto (default) probes with server/discover and

# falls back to the 2025-11-25 initialize handshake; pin 2026-07-28 or

# 2025-11-25 to skip detection.

# protocol_version: auto

stdio:

command: null

args: []

cwd: null

env: {}

# Optional: roots to expose via roots/list to the server.

# Servers use roots to understand the client's workspace context.

# roots:

# - uri: "file:///home/user/project"

# name: "Project Root"

# - uri: "file:///home/user/data"

defaults:

output: human # human | json | ndjson

logging:

level: warn # trace | debug | info | warn | error

format: pretty # pretty | json

outputs:

- kind: stderr # stderr | stdout | file

auth:

browser_open_command: null # Optional command for OAuth browser flows

events:

enable_stdio_events: true # Human-readable events on stderr

# http_endpoint: "http://127.0.0.1:9090/events" # HTTP webhook (POST JSON)

# local_socket_path: "/tmp/mcp2cli-events.sock" # Unix socket (NDJSON)

# sse_endpoint: "127.0.0.1:9091" # SSE server (text/event-stream)

# command: "logger -t mcp2cli '${MCP_EVENT_MESSAGE}'" # Shell command per event

# Env vars: MCP_EVENT_TYPE, MCP_EVENT_JSON, MCP_EVENT_APP_ID, MCP_EVENT_MESSAGE

# Anonymous usage telemetry — helps us understand which features are used.

# No sensitive data is collected (no endpoints, arguments, tool names, or URIs).

# Disable: set enabled: false, or MCP2CLI_TELEMETRY=off, or --no-telemetry flag.

# Respects DO_NOT_TRACK env var (https://consoledonottrack.com/).

telemetry:

enabled: true # Master switch (opt-out)

# endpoint: "https://telemetry.example.com/v1/events" # Optional HTTP collector

# batch_size: 25 # Events per HTTP batch

# Optional: customize the dynamic CLI surface.

# Without this section, server capabilities become CLI commands using their

# original names and auto-grouped by dotted prefixes.

#

# profile:

# display_name: "My Custom Tool" # Shown in --help banner

# aliases: # Rename commands (top-level or grouped)

# long-running-operation: lro

# get-tiny-image: image

# create.payload: object # Rename grouped: "create payload" → "create object"

# hide: # Hide commands from help/ls

# - print-env

# - debug-internal

# groups: # Custom subcommand grouping

# debug:

# - print-env

# - annotated-message

# flags: # Rename flags per command

# echo:

# message: msg

# resource_verb: get # Verb for resource reads (get|fetch|read)

# ── Discovery ──────────────────────────────────────────────────────────

# Where the dynamic CLI gets its command list.

#

# discovery:

# auto: true # Discover on demand when nothing is cached

# snapshot: inventory.json # Bundled command list, relative to this file

# ttl_seconds: 86400 # Re-discover when the list is older than this

# ── Branding ───────────────────────────────────────────────────────────

# Publish this config as a CLI under its own name. Presence of this section

# switches to embedded mode: own help header and version, only the listed

# built-in commands, own data directory, mcp2cli telemetry off.

# `mcp2cli package init` writes this for you. See docs/features/branded-cli.md

#

# branding:

# name: email # Product name (data dir, OAuth client name)

# about: Send mail from your terminal # Help header

# version: 1.4.0 # What --version prints

# builtin_commands: [auth] # Omit = all, [] = none

# after_help: "Docs: https://example.com"