Configuration

All fields are optional except appId.

Field	Default	Meaning
`appId`	—	The Feishu app id. Required.
`appSecretRef`	`FEISHU_APP_SECRET`	Credential reference resolved through the harness credential store, then the environment.
`appSecret`	`''`	Literal fallback. Discouraged: it puts a secret in configuration.
`brand`	`feishu`	`feishu` (open.feishu.cn) or `lark` (open.larksuite.com).
`apiBaseUrl` / `accountsBaseUrl`	per brand	Override the endpoints (for a proxy or a private gateway).
`defaultFolderToken`	`''`	Where new documents, sheets, Bitable apps, and uploads go when a call omits a folder.
`defaultIdentity`	`auto`	`auto`, `user`, or `app`. `auto` uses the user when authorized and otherwise the app, reporting the fallback.
`toolPrefix`	`feishu_`	Rename the tools (for example `fs_`).
`requestTimeoutMs`	`30000`	Per-attempt timeout.
`maxRetries`	`2`	Total attempts for rate-limited or transient failures (capped at 6).
`enableTools`	`true`	Register the model-facing tools.
`enableOAuth`	`true`	Mount the `/api/feishu/*` routes (status, activity, config, OAuth).
`enableUi`	`true`	Show the floating panel.
`oauthRedirectUri`	auto	Override the callback. Empty means "use the host webserver's loopback address".
`oauthScopes`	recommended set	Scopes requested by the authorization flow.
`registerSystemPrompt`	`true`	Append the Feishu guidance section to the system prompt.
`activityLogSize`	`50`	Entries retained for the browser panel.
`maxRecordsPerPage`	`500`	Page-size cap for paginated Feishu reads.
`patchFilePath`	auto	The profile patch file the settings page edits. Not writable from the browser.
`userAccessToken`	`''`	Static user token for headless use; skips OAuth entirely.

Environment fallbacks: FEISHU_APP_ID, FEISHU_APP_SECRET, FEISHU_BRAND, FEISHU_FOLDER_TOKEN, FEISHU_USER_ACCESS_TOKEN.

dsh-feishu

Other repositories with this package name

Install

README

Configuration