Files
deepseek-harness/packages/api/settings-controller/README.md
T

3.0 KiB

description, kind
description kind
Host Remote owner for settings and credential configuration surfaces, including redacted reads, path-addressed settings writes, and credential reference management. package-reference

Settings Controller

English | 中文

Summary

@deepseek-ai/dsh-api-settings-controller exposes generated ctx.remote.settings and ctx.remote.credentials namespaces for browser configuration surfaces. It returns redacted settings and credential metadata, supports merge, replacement, and path-addressed settings writes, and stores or removes credential references without returning secret values. When either provider is absent, its namespace remains registered and returns an actionable configuration error.

Table of Contents


Use this package

Mount this package as a Loader entry in a profile that serves browser configuration. The entry registers both namespaces independently of their providers so a missing provider produces a named configuration error at invocation. Its generated descriptors enter the strict Typert registry, while the settings and credential Definitions remain plain Cordis Services with no wire obligations of their own.

describe(refs) answers one map keyed by the requested names, so a settings page describing every reference its rows carry settles those rows together. It accepts at most 64 names per call, reports an invalid name or empty write value as bad-request, and copies each answer field by field — a provider returning more than CredentialInfo declares cannot widen what crosses. Valid set(ref, value) and unset(ref) calls report a provider refusal as credential-rejected, carrying the provider's message with only the reference in its details. Secret values cross in this direction only: no method here returns one.

settings.describe() returns deployment facts and every namespace under redactSecrets: true. settings.update, settings.replace, and settings.mutate expose the settings service's three write operations and return the namespace's new redacted view; stale writes use settings-conflict and other provider refusals use settings-rejected.


Model Experience

None, as settings and credential configuration are browser and Host state and register no prompt, tool, or session event.

KV Cache effect

No direct effect; reading or writing these configuration values does not alter model requests already in flight.

Known Limitations and Deferred Work

  • Settings document opening uses API Proxy rather than this Remote namespace.
  • The batch bound is fixed at 64 references and is not a deployment-configurable field.

Dev Note

Working context for maintainers — click to expand

None.