| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146 |
- 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 RuntimeFeatureConfig {
- hooks: RuntimeHookConfig,
- mcp: McpConfigCollection,
- oauth: Option<OAuthConfig>,
- model: Option<String>,
- permission_mode: Option<ResolvedPermissionMode>,
- permission_rules: RuntimePermissionRuleConfig,
- sandbox: SandboxConfig,
- }
- #[derive(Debug, Clone, PartialEq, Eq, Default)]
- pub struct RuntimeHookConfig {
- pre_tool_use: Vec<String>,
- post_tool_use: Vec<String>,
- post_tool_use_failure: Vec<String>,
- }
- #[derive(Debug, Clone, PartialEq, Eq, Default)]
- pub struct RuntimePermissionRuleConfig {
- allow: Vec<String>,
- deny: Vec<String>,
- ask: 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 = 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"));
- Self { cwd, 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)?,
- 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)?,
- permission_rules: parse_optional_permission_rules(&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 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 permission_rules(&self) -> &RuntimePermissionRuleConfig {
- &self.feature_config.permission_rules
- }
- #[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 hooks(&self) -> &RuntimeHookConfig {
- &self.hooks
- }
- #[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 permission_rules(&self) -> &RuntimePermissionRuleConfig {
- &self.permission_rules
- }
- #[must_use]
- pub fn sandbox(&self) -> &SandboxConfig {
- &self.sandbox
- }
- }
- impl RuntimeHookConfig {
- #[must_use]
- pub fn new(
- pre_tool_use: Vec<String>,
- post_tool_use: Vec<String>,
- post_tool_use_failure: Vec<String>,
- ) -> Self {
- Self {
- pre_tool_use,
- post_tool_use,
- post_tool_use_failure,
- }
- }
- #[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 post_tool_use_failure(&self) -> &[String] {
- &self.post_tool_use_failure
- }
- }
- impl RuntimePermissionRuleConfig {
- #[must_use]
- pub fn new(allow: Vec<String>, deny: Vec<String>, ask: Vec<String>) -> Self {
- Self { allow, deny, ask }
- }
- #[must_use]
- pub fn allow(&self) -> &[String] {
- &self.allow
- }
- #[must_use]
- pub fn deny(&self) -> &[String] {
- &self.deny
- }
- #[must_use]
- pub fn ask(&self) -> &[String] {
- &self.ask
- }
- }
- 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(),
- post_tool_use_failure: optional_string_array(
- hooks,
- "PostToolUseFailure",
- "merged settings.hooks",
- )?
- .unwrap_or_default(),
- })
- }
- fn parse_optional_permission_rules(
- root: &JsonValue,
- ) -> Result<RuntimePermissionRuleConfig, ConfigError> {
- let Some(object) = root.as_object() else {
- return Ok(RuntimePermissionRuleConfig::default());
- };
- let Some(permissions) = object.get("permissions").and_then(JsonValue::as_object) else {
- return Ok(RuntimePermissionRuleConfig::default());
- };
- Ok(RuntimePermissionRuleConfig {
- allow: optional_string_array(permissions, "allow", "merged settings.permissions")?
- .unwrap_or_default(),
- deny: optional_string_array(permissions, "deny", "merged settings.permissions")?
- .unwrap_or_default(),
- ask: optional_string_array(permissions, "ask", "merged settings.permissions")?
- .unwrap_or_default(),
- })
- }
- 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(),
- })),
- "managed-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 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());
- }
- }
- }
- }
- #[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_claw_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","allow":["Read"],"deny":["Bash(rm -rf)"]}}"#,
- )
- .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"],"PostToolUseFailure":["project-failure"]},"permissions":{"ask":["Edit"]},"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_eq!(
- loaded.hooks().post_tool_use_failure(),
- &["project-failure".to_string()]
- );
- assert_eq!(loaded.permission_rules().allow(), &["Read".to_string()]);
- assert_eq!(
- loaded.permission_rules().deny(),
- &["Bash(rm -rf)".to_string()]
- );
- assert_eq!(loaded.permission_rules().ask(), &["Edit".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 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");
- }
- }
|