| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294 |
- use std::collections::BTreeMap;
- use std::fmt::{Display, Formatter};
- use std::fs;
- use std::path::{Path, PathBuf};
- use crate::json::JsonValue;
- use crate::sandbox::{FilesystemIsolationMode, SandboxConfig};
- pub const CLAW_SETTINGS_SCHEMA_NAME: &str = "SettingsSchema";
- #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
- pub enum ConfigSource {
- User,
- Project,
- Local,
- }
- #[derive(Debug, Clone, Copy, PartialEq, Eq)]
- pub enum ResolvedPermissionMode {
- ReadOnly,
- WorkspaceWrite,
- DangerFullAccess,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct ConfigEntry {
- pub source: ConfigSource,
- pub path: PathBuf,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct RuntimeConfig {
- merged: BTreeMap<String, JsonValue>,
- loaded_entries: Vec<ConfigEntry>,
- feature_config: RuntimeFeatureConfig,
- }
- #[derive(Debug, Clone, PartialEq, Eq, Default)]
- pub struct RuntimePluginConfig {
- enabled_plugins: BTreeMap<String, bool>,
- external_directories: Vec<String>,
- install_root: Option<String>,
- registry_path: Option<String>,
- bundled_root: Option<String>,
- }
- #[derive(Debug, Clone, PartialEq, Eq, Default)]
- pub struct RuntimeFeatureConfig {
- hooks: RuntimeHookConfig,
- plugins: RuntimePluginConfig,
- mcp: McpConfigCollection,
- oauth: Option<OAuthConfig>,
- model: Option<String>,
- permission_mode: Option<ResolvedPermissionMode>,
- sandbox: SandboxConfig,
- }
- #[derive(Debug, Clone, PartialEq, Eq, Default)]
- pub struct RuntimeHookConfig {
- pre_tool_use: Vec<String>,
- post_tool_use: Vec<String>,
- }
- #[derive(Debug, Clone, PartialEq, Eq, Default)]
- pub struct McpConfigCollection {
- servers: BTreeMap<String, ScopedMcpServerConfig>,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct ScopedMcpServerConfig {
- pub scope: ConfigSource,
- pub config: McpServerConfig,
- }
- #[derive(Debug, Clone, Copy, PartialEq, Eq)]
- pub enum McpTransport {
- Stdio,
- Sse,
- Http,
- Ws,
- Sdk,
- ManagedProxy,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub enum McpServerConfig {
- Stdio(McpStdioServerConfig),
- Sse(McpRemoteServerConfig),
- Http(McpRemoteServerConfig),
- Ws(McpWebSocketServerConfig),
- Sdk(McpSdkServerConfig),
- ManagedProxy(McpManagedProxyServerConfig),
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct McpStdioServerConfig {
- pub command: String,
- pub args: Vec<String>,
- pub env: BTreeMap<String, String>,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct McpRemoteServerConfig {
- pub url: String,
- pub headers: BTreeMap<String, String>,
- pub headers_helper: Option<String>,
- pub oauth: Option<McpOAuthConfig>,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct McpWebSocketServerConfig {
- pub url: String,
- pub headers: BTreeMap<String, String>,
- pub headers_helper: Option<String>,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct McpSdkServerConfig {
- pub name: String,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct McpManagedProxyServerConfig {
- pub url: String,
- pub id: String,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct McpOAuthConfig {
- pub client_id: Option<String>,
- pub callback_port: Option<u16>,
- pub auth_server_metadata_url: Option<String>,
- pub xaa: Option<bool>,
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct OAuthConfig {
- pub client_id: String,
- pub authorize_url: String,
- pub token_url: String,
- pub callback_port: Option<u16>,
- pub manual_redirect_url: Option<String>,
- pub scopes: Vec<String>,
- }
- #[derive(Debug)]
- pub enum ConfigError {
- Io(std::io::Error),
- Parse(String),
- }
- impl Display for ConfigError {
- fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
- match self {
- Self::Io(error) => write!(f, "{error}"),
- Self::Parse(error) => write!(f, "{error}"),
- }
- }
- }
- impl std::error::Error for ConfigError {}
- impl From<std::io::Error> for ConfigError {
- fn from(value: std::io::Error) -> Self {
- Self::Io(value)
- }
- }
- #[derive(Debug, Clone, PartialEq, Eq)]
- pub struct ConfigLoader {
- cwd: PathBuf,
- config_home: PathBuf,
- }
- impl ConfigLoader {
- #[must_use]
- pub fn new(cwd: impl Into<PathBuf>, config_home: impl Into<PathBuf>) -> Self {
- Self {
- cwd: cwd.into(),
- config_home: config_home.into(),
- }
- }
- #[must_use]
- pub fn default_for(cwd: impl Into<PathBuf>) -> Self {
- let cwd = cwd.into();
- let config_home = default_config_home();
- Self { cwd, config_home }
- }
- #[must_use]
- pub fn config_home(&self) -> &Path {
- &self.config_home
- }
- #[must_use]
- pub fn discover(&self) -> Vec<ConfigEntry> {
- let user_legacy_path = self.config_home.parent().map_or_else(
- || PathBuf::from(".claw.json"),
- |parent| parent.join(".claw.json"),
- );
- vec![
- ConfigEntry {
- source: ConfigSource::User,
- path: user_legacy_path,
- },
- ConfigEntry {
- source: ConfigSource::User,
- path: self.config_home.join("settings.json"),
- },
- ConfigEntry {
- source: ConfigSource::Project,
- path: self.cwd.join(".claw.json"),
- },
- ConfigEntry {
- source: ConfigSource::Project,
- path: self.cwd.join(".claw").join("settings.json"),
- },
- ConfigEntry {
- source: ConfigSource::Local,
- path: self.cwd.join(".claw").join("settings.local.json"),
- },
- ]
- }
- pub fn load(&self) -> Result<RuntimeConfig, ConfigError> {
- let mut merged = BTreeMap::new();
- let mut loaded_entries = Vec::new();
- let mut mcp_servers = BTreeMap::new();
- for entry in self.discover() {
- let Some(value) = read_optional_json_object(&entry.path)? else {
- continue;
- };
- merge_mcp_servers(&mut mcp_servers, entry.source, &value, &entry.path)?;
- deep_merge_objects(&mut merged, &value);
- loaded_entries.push(entry);
- }
- let merged_value = JsonValue::Object(merged.clone());
- let feature_config = RuntimeFeatureConfig {
- hooks: parse_optional_hooks_config(&merged_value)?,
- plugins: parse_optional_plugin_config(&merged_value)?,
- mcp: McpConfigCollection {
- servers: mcp_servers,
- },
- oauth: parse_optional_oauth_config(&merged_value, "merged settings.oauth")?,
- model: parse_optional_model(&merged_value),
- permission_mode: parse_optional_permission_mode(&merged_value)?,
- sandbox: parse_optional_sandbox_config(&merged_value)?,
- };
- Ok(RuntimeConfig {
- merged,
- loaded_entries,
- feature_config,
- })
- }
- }
- impl RuntimeConfig {
- #[must_use]
- pub fn empty() -> Self {
- Self {
- merged: BTreeMap::new(),
- loaded_entries: Vec::new(),
- feature_config: RuntimeFeatureConfig::default(),
- }
- }
- #[must_use]
- pub fn merged(&self) -> &BTreeMap<String, JsonValue> {
- &self.merged
- }
- #[must_use]
- pub fn loaded_entries(&self) -> &[ConfigEntry] {
- &self.loaded_entries
- }
- #[must_use]
- pub fn get(&self, key: &str) -> Option<&JsonValue> {
- self.merged.get(key)
- }
- #[must_use]
- pub fn as_json(&self) -> JsonValue {
- JsonValue::Object(self.merged.clone())
- }
- #[must_use]
- pub fn feature_config(&self) -> &RuntimeFeatureConfig {
- &self.feature_config
- }
- #[must_use]
- pub fn mcp(&self) -> &McpConfigCollection {
- &self.feature_config.mcp
- }
- #[must_use]
- pub fn hooks(&self) -> &RuntimeHookConfig {
- &self.feature_config.hooks
- }
- #[must_use]
- pub fn plugins(&self) -> &RuntimePluginConfig {
- &self.feature_config.plugins
- }
- #[must_use]
- pub fn oauth(&self) -> Option<&OAuthConfig> {
- self.feature_config.oauth.as_ref()
- }
- #[must_use]
- pub fn model(&self) -> Option<&str> {
- self.feature_config.model.as_deref()
- }
- #[must_use]
- pub fn permission_mode(&self) -> Option<ResolvedPermissionMode> {
- self.feature_config.permission_mode
- }
- #[must_use]
- pub fn sandbox(&self) -> &SandboxConfig {
- &self.feature_config.sandbox
- }
- }
- impl RuntimeFeatureConfig {
- #[must_use]
- pub fn with_hooks(mut self, hooks: RuntimeHookConfig) -> Self {
- self.hooks = hooks;
- self
- }
- #[must_use]
- pub fn with_plugins(mut self, plugins: RuntimePluginConfig) -> Self {
- self.plugins = plugins;
- self
- }
- #[must_use]
- pub fn hooks(&self) -> &RuntimeHookConfig {
- &self.hooks
- }
- #[must_use]
- pub fn plugins(&self) -> &RuntimePluginConfig {
- &self.plugins
- }
- #[must_use]
- pub fn mcp(&self) -> &McpConfigCollection {
- &self.mcp
- }
- #[must_use]
- pub fn oauth(&self) -> Option<&OAuthConfig> {
- self.oauth.as_ref()
- }
- #[must_use]
- pub fn model(&self) -> Option<&str> {
- self.model.as_deref()
- }
- #[must_use]
- pub fn permission_mode(&self) -> Option<ResolvedPermissionMode> {
- self.permission_mode
- }
- #[must_use]
- pub fn sandbox(&self) -> &SandboxConfig {
- &self.sandbox
- }
- }
- impl RuntimePluginConfig {
- #[must_use]
- pub fn enabled_plugins(&self) -> &BTreeMap<String, bool> {
- &self.enabled_plugins
- }
- #[must_use]
- pub fn external_directories(&self) -> &[String] {
- &self.external_directories
- }
- #[must_use]
- pub fn install_root(&self) -> Option<&str> {
- self.install_root.as_deref()
- }
- #[must_use]
- pub fn registry_path(&self) -> Option<&str> {
- self.registry_path.as_deref()
- }
- #[must_use]
- pub fn bundled_root(&self) -> Option<&str> {
- self.bundled_root.as_deref()
- }
- pub fn set_plugin_state(&mut self, plugin_id: String, enabled: bool) {
- self.enabled_plugins.insert(plugin_id, enabled);
- }
- #[must_use]
- pub fn state_for(&self, plugin_id: &str, default_enabled: bool) -> bool {
- self.enabled_plugins
- .get(plugin_id)
- .copied()
- .unwrap_or(default_enabled)
- }
- }
- #[must_use]
- pub fn default_config_home() -> PathBuf {
- std::env::var_os("CLAW_CONFIG_HOME")
- .map(PathBuf::from)
- .or_else(|| std::env::var_os("HOME").map(|home| PathBuf::from(home).join(".claw")))
- .unwrap_or_else(|| PathBuf::from(".claw"))
- }
- impl RuntimeHookConfig {
- #[must_use]
- pub fn new(pre_tool_use: Vec<String>, post_tool_use: Vec<String>) -> Self {
- Self {
- pre_tool_use,
- post_tool_use,
- }
- }
- #[must_use]
- pub fn pre_tool_use(&self) -> &[String] {
- &self.pre_tool_use
- }
- #[must_use]
- pub fn post_tool_use(&self) -> &[String] {
- &self.post_tool_use
- }
- #[must_use]
- pub fn merged(&self, other: &Self) -> Self {
- let mut merged = self.clone();
- merged.extend(other);
- merged
- }
- pub fn extend(&mut self, other: &Self) {
- extend_unique(&mut self.pre_tool_use, other.pre_tool_use());
- extend_unique(&mut self.post_tool_use, other.post_tool_use());
- }
- }
- impl McpConfigCollection {
- #[must_use]
- pub fn servers(&self) -> &BTreeMap<String, ScopedMcpServerConfig> {
- &self.servers
- }
- #[must_use]
- pub fn get(&self, name: &str) -> Option<&ScopedMcpServerConfig> {
- self.servers.get(name)
- }
- }
- impl ScopedMcpServerConfig {
- #[must_use]
- pub fn transport(&self) -> McpTransport {
- self.config.transport()
- }
- }
- impl McpServerConfig {
- #[must_use]
- pub fn transport(&self) -> McpTransport {
- match self {
- Self::Stdio(_) => McpTransport::Stdio,
- Self::Sse(_) => McpTransport::Sse,
- Self::Http(_) => McpTransport::Http,
- Self::Ws(_) => McpTransport::Ws,
- Self::Sdk(_) => McpTransport::Sdk,
- Self::ManagedProxy(_) => McpTransport::ManagedProxy,
- }
- }
- }
- fn read_optional_json_object(
- path: &Path,
- ) -> Result<Option<BTreeMap<String, JsonValue>>, ConfigError> {
- let is_legacy_config = path.file_name().and_then(|name| name.to_str()) == Some(".claw.json");
- let contents = match fs::read_to_string(path) {
- Ok(contents) => contents,
- Err(error) if error.kind() == std::io::ErrorKind::NotFound => return Ok(None),
- Err(error) => return Err(ConfigError::Io(error)),
- };
- if contents.trim().is_empty() {
- return Ok(Some(BTreeMap::new()));
- }
- let parsed = match JsonValue::parse(&contents) {
- Ok(parsed) => parsed,
- Err(error) if is_legacy_config => return Ok(None),
- Err(error) => return Err(ConfigError::Parse(format!("{}: {error}", path.display()))),
- };
- let Some(object) = parsed.as_object() else {
- if is_legacy_config {
- return Ok(None);
- }
- return Err(ConfigError::Parse(format!(
- "{}: top-level settings value must be a JSON object",
- path.display()
- )));
- };
- Ok(Some(object.clone()))
- }
- fn merge_mcp_servers(
- target: &mut BTreeMap<String, ScopedMcpServerConfig>,
- source: ConfigSource,
- root: &BTreeMap<String, JsonValue>,
- path: &Path,
- ) -> Result<(), ConfigError> {
- let Some(mcp_servers) = root.get("mcpServers") else {
- return Ok(());
- };
- let servers = expect_object(mcp_servers, &format!("{}: mcpServers", path.display()))?;
- for (name, value) in servers {
- let parsed = parse_mcp_server_config(
- name,
- value,
- &format!("{}: mcpServers.{name}", path.display()),
- )?;
- target.insert(
- name.clone(),
- ScopedMcpServerConfig {
- scope: source,
- config: parsed,
- },
- );
- }
- Ok(())
- }
- fn parse_optional_model(root: &JsonValue) -> Option<String> {
- root.as_object()
- .and_then(|object| object.get("model"))
- .and_then(JsonValue::as_str)
- .map(ToOwned::to_owned)
- }
- fn parse_optional_hooks_config(root: &JsonValue) -> Result<RuntimeHookConfig, ConfigError> {
- let Some(object) = root.as_object() else {
- return Ok(RuntimeHookConfig::default());
- };
- let Some(hooks_value) = object.get("hooks") else {
- return Ok(RuntimeHookConfig::default());
- };
- let hooks = expect_object(hooks_value, "merged settings.hooks")?;
- Ok(RuntimeHookConfig {
- pre_tool_use: optional_string_array(hooks, "PreToolUse", "merged settings.hooks")?
- .unwrap_or_default(),
- post_tool_use: optional_string_array(hooks, "PostToolUse", "merged settings.hooks")?
- .unwrap_or_default(),
- })
- }
- fn parse_optional_plugin_config(root: &JsonValue) -> Result<RuntimePluginConfig, ConfigError> {
- let Some(object) = root.as_object() else {
- return Ok(RuntimePluginConfig::default());
- };
- let mut config = RuntimePluginConfig::default();
- if let Some(enabled_plugins) = object.get("enabledPlugins") {
- config.enabled_plugins = parse_bool_map(enabled_plugins, "merged settings.enabledPlugins")?;
- }
- let Some(plugins_value) = object.get("plugins") else {
- return Ok(config);
- };
- let plugins = expect_object(plugins_value, "merged settings.plugins")?;
- if let Some(enabled_value) = plugins.get("enabled") {
- config.enabled_plugins = parse_bool_map(enabled_value, "merged settings.plugins.enabled")?;
- }
- config.external_directories =
- optional_string_array(plugins, "externalDirectories", "merged settings.plugins")?
- .unwrap_or_default();
- config.install_root =
- optional_string(plugins, "installRoot", "merged settings.plugins")?.map(str::to_string);
- config.registry_path =
- optional_string(plugins, "registryPath", "merged settings.plugins")?.map(str::to_string);
- config.bundled_root =
- optional_string(plugins, "bundledRoot", "merged settings.plugins")?.map(str::to_string);
- Ok(config)
- }
- fn parse_optional_permission_mode(
- root: &JsonValue,
- ) -> Result<Option<ResolvedPermissionMode>, ConfigError> {
- let Some(object) = root.as_object() else {
- return Ok(None);
- };
- if let Some(mode) = object.get("permissionMode").and_then(JsonValue::as_str) {
- return parse_permission_mode_label(mode, "merged settings.permissionMode").map(Some);
- }
- let Some(mode) = object
- .get("permissions")
- .and_then(JsonValue::as_object)
- .and_then(|permissions| permissions.get("defaultMode"))
- .and_then(JsonValue::as_str)
- else {
- return Ok(None);
- };
- parse_permission_mode_label(mode, "merged settings.permissions.defaultMode").map(Some)
- }
- fn parse_permission_mode_label(
- mode: &str,
- context: &str,
- ) -> Result<ResolvedPermissionMode, ConfigError> {
- match mode {
- "default" | "plan" | "read-only" => Ok(ResolvedPermissionMode::ReadOnly),
- "acceptEdits" | "auto" | "workspace-write" => Ok(ResolvedPermissionMode::WorkspaceWrite),
- "dontAsk" | "danger-full-access" => Ok(ResolvedPermissionMode::DangerFullAccess),
- other => Err(ConfigError::Parse(format!(
- "{context}: unsupported permission mode {other}"
- ))),
- }
- }
- fn parse_optional_sandbox_config(root: &JsonValue) -> Result<SandboxConfig, ConfigError> {
- let Some(object) = root.as_object() else {
- return Ok(SandboxConfig::default());
- };
- let Some(sandbox_value) = object.get("sandbox") else {
- return Ok(SandboxConfig::default());
- };
- let sandbox = expect_object(sandbox_value, "merged settings.sandbox")?;
- let filesystem_mode = optional_string(sandbox, "filesystemMode", "merged settings.sandbox")?
- .map(parse_filesystem_mode_label)
- .transpose()?;
- Ok(SandboxConfig {
- enabled: optional_bool(sandbox, "enabled", "merged settings.sandbox")?,
- namespace_restrictions: optional_bool(
- sandbox,
- "namespaceRestrictions",
- "merged settings.sandbox",
- )?,
- network_isolation: optional_bool(sandbox, "networkIsolation", "merged settings.sandbox")?,
- filesystem_mode,
- allowed_mounts: optional_string_array(sandbox, "allowedMounts", "merged settings.sandbox")?
- .unwrap_or_default(),
- })
- }
- fn parse_filesystem_mode_label(value: &str) -> Result<FilesystemIsolationMode, ConfigError> {
- match value {
- "off" => Ok(FilesystemIsolationMode::Off),
- "workspace-only" => Ok(FilesystemIsolationMode::WorkspaceOnly),
- "allow-list" => Ok(FilesystemIsolationMode::AllowList),
- other => Err(ConfigError::Parse(format!(
- "merged settings.sandbox.filesystemMode: unsupported filesystem mode {other}"
- ))),
- }
- }
- fn parse_optional_oauth_config(
- root: &JsonValue,
- context: &str,
- ) -> Result<Option<OAuthConfig>, ConfigError> {
- let Some(oauth_value) = root.as_object().and_then(|object| object.get("oauth")) else {
- return Ok(None);
- };
- let object = expect_object(oauth_value, context)?;
- let client_id = expect_string(object, "clientId", context)?.to_string();
- let authorize_url = expect_string(object, "authorizeUrl", context)?.to_string();
- let token_url = expect_string(object, "tokenUrl", context)?.to_string();
- let callback_port = optional_u16(object, "callbackPort", context)?;
- let manual_redirect_url =
- optional_string(object, "manualRedirectUrl", context)?.map(str::to_string);
- let scopes = optional_string_array(object, "scopes", context)?.unwrap_or_default();
- Ok(Some(OAuthConfig {
- client_id,
- authorize_url,
- token_url,
- callback_port,
- manual_redirect_url,
- scopes,
- }))
- }
- fn parse_mcp_server_config(
- server_name: &str,
- value: &JsonValue,
- context: &str,
- ) -> Result<McpServerConfig, ConfigError> {
- let object = expect_object(value, context)?;
- let server_type = optional_string(object, "type", context)?.unwrap_or("stdio");
- match server_type {
- "stdio" => Ok(McpServerConfig::Stdio(McpStdioServerConfig {
- command: expect_string(object, "command", context)?.to_string(),
- args: optional_string_array(object, "args", context)?.unwrap_or_default(),
- env: optional_string_map(object, "env", context)?.unwrap_or_default(),
- })),
- "sse" => Ok(McpServerConfig::Sse(parse_mcp_remote_server_config(
- object, context,
- )?)),
- "http" => Ok(McpServerConfig::Http(parse_mcp_remote_server_config(
- object, context,
- )?)),
- "ws" => Ok(McpServerConfig::Ws(McpWebSocketServerConfig {
- url: expect_string(object, "url", context)?.to_string(),
- headers: optional_string_map(object, "headers", context)?.unwrap_or_default(),
- headers_helper: optional_string(object, "headersHelper", context)?.map(str::to_string),
- })),
- "sdk" => Ok(McpServerConfig::Sdk(McpSdkServerConfig {
- name: expect_string(object, "name", context)?.to_string(),
- })),
- "claudeai-proxy" => Ok(McpServerConfig::ManagedProxy(McpManagedProxyServerConfig {
- url: expect_string(object, "url", context)?.to_string(),
- id: expect_string(object, "id", context)?.to_string(),
- })),
- other => Err(ConfigError::Parse(format!(
- "{context}: unsupported MCP server type for {server_name}: {other}"
- ))),
- }
- }
- fn parse_mcp_remote_server_config(
- object: &BTreeMap<String, JsonValue>,
- context: &str,
- ) -> Result<McpRemoteServerConfig, ConfigError> {
- Ok(McpRemoteServerConfig {
- url: expect_string(object, "url", context)?.to_string(),
- headers: optional_string_map(object, "headers", context)?.unwrap_or_default(),
- headers_helper: optional_string(object, "headersHelper", context)?.map(str::to_string),
- oauth: parse_optional_mcp_oauth_config(object, context)?,
- })
- }
- fn parse_optional_mcp_oauth_config(
- object: &BTreeMap<String, JsonValue>,
- context: &str,
- ) -> Result<Option<McpOAuthConfig>, ConfigError> {
- let Some(value) = object.get("oauth") else {
- return Ok(None);
- };
- let oauth = expect_object(value, &format!("{context}.oauth"))?;
- Ok(Some(McpOAuthConfig {
- client_id: optional_string(oauth, "clientId", context)?.map(str::to_string),
- callback_port: optional_u16(oauth, "callbackPort", context)?,
- auth_server_metadata_url: optional_string(oauth, "authServerMetadataUrl", context)?
- .map(str::to_string),
- xaa: optional_bool(oauth, "xaa", context)?,
- }))
- }
- fn expect_object<'a>(
- value: &'a JsonValue,
- context: &str,
- ) -> Result<&'a BTreeMap<String, JsonValue>, ConfigError> {
- value
- .as_object()
- .ok_or_else(|| ConfigError::Parse(format!("{context}: expected JSON object")))
- }
- fn expect_string<'a>(
- object: &'a BTreeMap<String, JsonValue>,
- key: &str,
- context: &str,
- ) -> Result<&'a str, ConfigError> {
- object
- .get(key)
- .and_then(JsonValue::as_str)
- .ok_or_else(|| ConfigError::Parse(format!("{context}: missing string field {key}")))
- }
- fn optional_string<'a>(
- object: &'a BTreeMap<String, JsonValue>,
- key: &str,
- context: &str,
- ) -> Result<Option<&'a str>, ConfigError> {
- match object.get(key) {
- Some(value) => value
- .as_str()
- .map(Some)
- .ok_or_else(|| ConfigError::Parse(format!("{context}: field {key} must be a string"))),
- None => Ok(None),
- }
- }
- fn optional_bool(
- object: &BTreeMap<String, JsonValue>,
- key: &str,
- context: &str,
- ) -> Result<Option<bool>, ConfigError> {
- match object.get(key) {
- Some(value) => value
- .as_bool()
- .map(Some)
- .ok_or_else(|| ConfigError::Parse(format!("{context}: field {key} must be a boolean"))),
- None => Ok(None),
- }
- }
- fn optional_u16(
- object: &BTreeMap<String, JsonValue>,
- key: &str,
- context: &str,
- ) -> Result<Option<u16>, ConfigError> {
- match object.get(key) {
- Some(value) => {
- let Some(number) = value.as_i64() else {
- return Err(ConfigError::Parse(format!(
- "{context}: field {key} must be an integer"
- )));
- };
- let number = u16::try_from(number).map_err(|_| {
- ConfigError::Parse(format!("{context}: field {key} is out of range"))
- })?;
- Ok(Some(number))
- }
- None => Ok(None),
- }
- }
- fn parse_bool_map(value: &JsonValue, context: &str) -> Result<BTreeMap<String, bool>, ConfigError> {
- let Some(map) = value.as_object() else {
- return Err(ConfigError::Parse(format!(
- "{context}: expected JSON object"
- )));
- };
- map.iter()
- .map(|(key, value)| {
- value
- .as_bool()
- .map(|enabled| (key.clone(), enabled))
- .ok_or_else(|| {
- ConfigError::Parse(format!("{context}: field {key} must be a boolean"))
- })
- })
- .collect()
- }
- fn optional_string_array(
- object: &BTreeMap<String, JsonValue>,
- key: &str,
- context: &str,
- ) -> Result<Option<Vec<String>>, ConfigError> {
- match object.get(key) {
- Some(value) => {
- let Some(array) = value.as_array() else {
- return Err(ConfigError::Parse(format!(
- "{context}: field {key} must be an array"
- )));
- };
- array
- .iter()
- .map(|item| {
- item.as_str().map(ToOwned::to_owned).ok_or_else(|| {
- ConfigError::Parse(format!(
- "{context}: field {key} must contain only strings"
- ))
- })
- })
- .collect::<Result<Vec<_>, _>>()
- .map(Some)
- }
- None => Ok(None),
- }
- }
- fn optional_string_map(
- object: &BTreeMap<String, JsonValue>,
- key: &str,
- context: &str,
- ) -> Result<Option<BTreeMap<String, String>>, ConfigError> {
- match object.get(key) {
- Some(value) => {
- let Some(map) = value.as_object() else {
- return Err(ConfigError::Parse(format!(
- "{context}: field {key} must be an object"
- )));
- };
- map.iter()
- .map(|(entry_key, entry_value)| {
- entry_value
- .as_str()
- .map(|text| (entry_key.clone(), text.to_string()))
- .ok_or_else(|| {
- ConfigError::Parse(format!(
- "{context}: field {key} must contain only string values"
- ))
- })
- })
- .collect::<Result<BTreeMap<_, _>, _>>()
- .map(Some)
- }
- None => Ok(None),
- }
- }
- fn deep_merge_objects(
- target: &mut BTreeMap<String, JsonValue>,
- source: &BTreeMap<String, JsonValue>,
- ) {
- for (key, value) in source {
- match (target.get_mut(key), value) {
- (Some(JsonValue::Object(existing)), JsonValue::Object(incoming)) => {
- deep_merge_objects(existing, incoming);
- }
- _ => {
- target.insert(key.clone(), value.clone());
- }
- }
- }
- }
- fn extend_unique(target: &mut Vec<String>, values: &[String]) {
- for value in values {
- push_unique(target, value.clone());
- }
- }
- fn push_unique(target: &mut Vec<String>, value: String) {
- if !target.iter().any(|existing| existing == &value) {
- target.push(value);
- }
- }
- #[cfg(test)]
- mod tests {
- use super::{
- ConfigLoader, ConfigSource, McpServerConfig, McpTransport, ResolvedPermissionMode,
- CLAW_SETTINGS_SCHEMA_NAME,
- };
- use crate::json::JsonValue;
- use crate::sandbox::FilesystemIsolationMode;
- use std::fs;
- use std::time::{SystemTime, UNIX_EPOCH};
- fn temp_dir() -> std::path::PathBuf {
- let nanos = SystemTime::now()
- .duration_since(UNIX_EPOCH)
- .expect("time should be after epoch")
- .as_nanos();
- std::env::temp_dir().join(format!("runtime-config-{nanos}"))
- }
- #[test]
- fn rejects_non_object_settings_files() {
- let root = temp_dir();
- let cwd = root.join("project");
- let home = root.join("home").join(".claw");
- fs::create_dir_all(&home).expect("home config dir");
- fs::create_dir_all(&cwd).expect("project dir");
- fs::write(home.join("settings.json"), "[]").expect("write bad settings");
- let error = ConfigLoader::new(&cwd, &home)
- .load()
- .expect_err("config should fail");
- assert!(error
- .to_string()
- .contains("top-level settings value must be a JSON object"));
- fs::remove_dir_all(root).expect("cleanup temp dir");
- }
- #[test]
- fn loads_and_merges_claude_code_config_files_by_precedence() {
- let root = temp_dir();
- let cwd = root.join("project");
- let home = root.join("home").join(".claw");
- fs::create_dir_all(cwd.join(".claw")).expect("project config dir");
- fs::create_dir_all(&home).expect("home config dir");
- fs::write(
- home.parent().expect("home parent").join(".claw.json"),
- r#"{"model":"haiku","env":{"A":"1"},"mcpServers":{"home":{"command":"uvx","args":["home"]}}}"#,
- )
- .expect("write user compat config");
- fs::write(
- home.join("settings.json"),
- r#"{"model":"sonnet","env":{"A2":"1"},"hooks":{"PreToolUse":["base"]},"permissions":{"defaultMode":"plan"}}"#,
- )
- .expect("write user settings");
- fs::write(
- cwd.join(".claw.json"),
- r#"{"model":"project-compat","env":{"B":"2"}}"#,
- )
- .expect("write project compat config");
- fs::write(
- cwd.join(".claw").join("settings.json"),
- r#"{"env":{"C":"3"},"hooks":{"PostToolUse":["project"]},"mcpServers":{"project":{"command":"uvx","args":["project"]}}}"#,
- )
- .expect("write project settings");
- fs::write(
- cwd.join(".claw").join("settings.local.json"),
- r#"{"model":"opus","permissionMode":"acceptEdits"}"#,
- )
- .expect("write local settings");
- let loaded = ConfigLoader::new(&cwd, &home)
- .load()
- .expect("config should load");
- assert_eq!(CLAW_SETTINGS_SCHEMA_NAME, "SettingsSchema");
- assert_eq!(loaded.loaded_entries().len(), 5);
- assert_eq!(loaded.loaded_entries()[0].source, ConfigSource::User);
- assert_eq!(
- loaded.get("model"),
- Some(&JsonValue::String("opus".to_string()))
- );
- assert_eq!(loaded.model(), Some("opus"));
- assert_eq!(
- loaded.permission_mode(),
- Some(ResolvedPermissionMode::WorkspaceWrite)
- );
- assert_eq!(
- loaded
- .get("env")
- .and_then(JsonValue::as_object)
- .expect("env object")
- .len(),
- 4
- );
- assert!(loaded
- .get("hooks")
- .and_then(JsonValue::as_object)
- .expect("hooks object")
- .contains_key("PreToolUse"));
- assert!(loaded
- .get("hooks")
- .and_then(JsonValue::as_object)
- .expect("hooks object")
- .contains_key("PostToolUse"));
- assert_eq!(loaded.hooks().pre_tool_use(), &["base".to_string()]);
- assert_eq!(loaded.hooks().post_tool_use(), &["project".to_string()]);
- assert!(loaded.mcp().get("home").is_some());
- assert!(loaded.mcp().get("project").is_some());
- fs::remove_dir_all(root).expect("cleanup temp dir");
- }
- #[test]
- fn parses_sandbox_config() {
- let root = temp_dir();
- let cwd = root.join("project");
- let home = root.join("home").join(".claw");
- fs::create_dir_all(cwd.join(".claw")).expect("project config dir");
- fs::create_dir_all(&home).expect("home config dir");
- fs::write(
- cwd.join(".claw").join("settings.local.json"),
- r#"{
- "sandbox": {
- "enabled": true,
- "namespaceRestrictions": false,
- "networkIsolation": true,
- "filesystemMode": "allow-list",
- "allowedMounts": ["logs", "tmp/cache"]
- }
- }"#,
- )
- .expect("write local settings");
- let loaded = ConfigLoader::new(&cwd, &home)
- .load()
- .expect("config should load");
- assert_eq!(loaded.sandbox().enabled, Some(true));
- assert_eq!(loaded.sandbox().namespace_restrictions, Some(false));
- assert_eq!(loaded.sandbox().network_isolation, Some(true));
- assert_eq!(
- loaded.sandbox().filesystem_mode,
- Some(FilesystemIsolationMode::AllowList)
- );
- assert_eq!(loaded.sandbox().allowed_mounts, vec!["logs", "tmp/cache"]);
- fs::remove_dir_all(root).expect("cleanup temp dir");
- }
- #[test]
- fn parses_typed_mcp_and_oauth_config() {
- let root = temp_dir();
- let cwd = root.join("project");
- let home = root.join("home").join(".claw");
- fs::create_dir_all(cwd.join(".claw")).expect("project config dir");
- fs::create_dir_all(&home).expect("home config dir");
- fs::write(
- home.join("settings.json"),
- r#"{
- "mcpServers": {
- "stdio-server": {
- "command": "uvx",
- "args": ["mcp-server"],
- "env": {"TOKEN": "secret"}
- },
- "remote-server": {
- "type": "http",
- "url": "https://example.test/mcp",
- "headers": {"Authorization": "Bearer token"},
- "headersHelper": "helper.sh",
- "oauth": {
- "clientId": "mcp-client",
- "callbackPort": 7777,
- "authServerMetadataUrl": "https://issuer.test/.well-known/oauth-authorization-server",
- "xaa": true
- }
- }
- },
- "oauth": {
- "clientId": "runtime-client",
- "authorizeUrl": "https://console.test/oauth/authorize",
- "tokenUrl": "https://console.test/oauth/token",
- "callbackPort": 54545,
- "manualRedirectUrl": "https://console.test/oauth/callback",
- "scopes": ["org:read", "user:write"]
- }
- }"#,
- )
- .expect("write user settings");
- fs::write(
- cwd.join(".claw").join("settings.local.json"),
- r#"{
- "mcpServers": {
- "remote-server": {
- "type": "ws",
- "url": "wss://override.test/mcp",
- "headers": {"X-Env": "local"}
- }
- }
- }"#,
- )
- .expect("write local settings");
- let loaded = ConfigLoader::new(&cwd, &home)
- .load()
- .expect("config should load");
- let stdio_server = loaded
- .mcp()
- .get("stdio-server")
- .expect("stdio server should exist");
- assert_eq!(stdio_server.scope, ConfigSource::User);
- assert_eq!(stdio_server.transport(), McpTransport::Stdio);
- let remote_server = loaded
- .mcp()
- .get("remote-server")
- .expect("remote server should exist");
- assert_eq!(remote_server.scope, ConfigSource::Local);
- assert_eq!(remote_server.transport(), McpTransport::Ws);
- match &remote_server.config {
- McpServerConfig::Ws(config) => {
- assert_eq!(config.url, "wss://override.test/mcp");
- assert_eq!(
- config.headers.get("X-Env").map(String::as_str),
- Some("local")
- );
- }
- other => panic!("expected ws config, got {other:?}"),
- }
- let oauth = loaded.oauth().expect("oauth config should exist");
- assert_eq!(oauth.client_id, "runtime-client");
- assert_eq!(oauth.callback_port, Some(54_545));
- assert_eq!(oauth.scopes, vec!["org:read", "user:write"]);
- fs::remove_dir_all(root).expect("cleanup temp dir");
- }
- #[test]
- fn parses_plugin_config_from_enabled_plugins() {
- let root = temp_dir();
- let cwd = root.join("project");
- let home = root.join("home").join(".claw");
- fs::create_dir_all(cwd.join(".claw")).expect("project config dir");
- fs::create_dir_all(&home).expect("home config dir");
- fs::write(
- home.join("settings.json"),
- r#"{
- "enabledPlugins": {
- "tool-guard@builtin": true,
- "sample-plugin@external": false
- }
- }"#,
- )
- .expect("write user settings");
- let loaded = ConfigLoader::new(&cwd, &home)
- .load()
- .expect("config should load");
- assert_eq!(
- loaded.plugins().enabled_plugins().get("tool-guard@builtin"),
- Some(&true)
- );
- assert_eq!(
- loaded
- .plugins()
- .enabled_plugins()
- .get("sample-plugin@external"),
- Some(&false)
- );
- fs::remove_dir_all(root).expect("cleanup temp dir");
- }
- #[test]
- fn parses_plugin_config() {
- let root = temp_dir();
- let cwd = root.join("project");
- let home = root.join("home").join(".claw");
- fs::create_dir_all(cwd.join(".claw")).expect("project config dir");
- fs::create_dir_all(&home).expect("home config dir");
- fs::write(
- home.join("settings.json"),
- r#"{
- "enabledPlugins": {
- "core-helpers@builtin": true
- },
- "plugins": {
- "externalDirectories": ["./external-plugins"],
- "installRoot": "plugin-cache/installed",
- "registryPath": "plugin-cache/installed.json",
- "bundledRoot": "./bundled-plugins"
- }
- }"#,
- )
- .expect("write plugin settings");
- let loaded = ConfigLoader::new(&cwd, &home)
- .load()
- .expect("config should load");
- assert_eq!(
- loaded
- .plugins()
- .enabled_plugins()
- .get("core-helpers@builtin"),
- Some(&true)
- );
- assert_eq!(
- loaded.plugins().external_directories(),
- &["./external-plugins".to_string()]
- );
- assert_eq!(
- loaded.plugins().install_root(),
- Some("plugin-cache/installed")
- );
- assert_eq!(
- loaded.plugins().registry_path(),
- Some("plugin-cache/installed.json")
- );
- assert_eq!(loaded.plugins().bundled_root(), Some("./bundled-plugins"));
- fs::remove_dir_all(root).expect("cleanup temp dir");
- }
- #[test]
- fn rejects_invalid_mcp_server_shapes() {
- let root = temp_dir();
- let cwd = root.join("project");
- let home = root.join("home").join(".claw");
- fs::create_dir_all(&home).expect("home config dir");
- fs::create_dir_all(&cwd).expect("project dir");
- fs::write(
- home.join("settings.json"),
- r#"{"mcpServers":{"broken":{"type":"http","url":123}}}"#,
- )
- .expect("write broken settings");
- let error = ConfigLoader::new(&cwd, &home)
- .load()
- .expect_err("config should fail");
- assert!(error
- .to_string()
- .contains("mcpServers.broken: missing string field url"));
- fs::remove_dir_all(root).expect("cleanup temp dir");
- }
- }
|