1use regex::Regex;
2use serde::{Deserialize, Serialize};
3use std::collections::{BTreeMap, HashMap};
4
5#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
7#[derive(Debug, Clone, Deserialize, Serialize)]
8pub struct McpClientConfig {
9 #[serde(default = "default_mcp_enabled")]
11 pub enabled: bool,
12
13 #[serde(default)]
15 pub ui: McpUiConfig,
16
17 #[serde(default)]
19 pub providers: Vec<McpProviderConfig>,
20
21 #[serde(default)]
23 pub server: McpServerConfig,
24
25 #[serde(default)]
27 pub allowlist: McpAllowListConfig,
28
29 #[serde(default = "default_max_concurrent_connections")]
31 pub max_concurrent_connections: usize,
32
33 #[serde(default = "default_request_timeout_seconds")]
35 pub request_timeout_seconds: u64,
36
37 #[serde(default = "default_retry_attempts")]
39 pub retry_attempts: u32,
40
41 #[serde(default)]
43 pub startup_timeout_seconds: Option<u64>,
44
45 #[serde(default)]
47 pub tool_timeout_seconds: Option<u64>,
48
49 #[serde(default = "default_experimental_use_rmcp_client")]
51 pub experimental_use_rmcp_client: bool,
52
53 #[serde(default)]
55 pub security: McpSecurityConfig,
56}
57
58#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
60#[derive(Debug, Clone, Deserialize, Serialize)]
61pub struct McpSecurityConfig {
62 #[serde(default = "default_mcp_auth_enabled")]
64 pub auth_enabled: bool,
65
66 #[serde(default)]
68 pub api_key_env: Option<String>,
69
70 #[serde(default)]
72 pub rate_limit: McpRateLimitConfig,
73
74 #[serde(default)]
76 pub validation: McpValidationConfig,
77}
78
79impl Default for McpSecurityConfig {
80 fn default() -> Self {
81 Self {
82 auth_enabled: default_mcp_auth_enabled(),
83 api_key_env: None,
84 rate_limit: McpRateLimitConfig::default(),
85 validation: McpValidationConfig::default(),
86 }
87 }
88}
89
90#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
92#[derive(Debug, Clone, Deserialize, Serialize)]
93pub struct McpRateLimitConfig {
94 #[serde(default = "default_requests_per_minute")]
96 pub requests_per_minute: u32,
97
98 #[serde(default = "default_concurrent_requests")]
100 pub concurrent_requests: u32,
101}
102
103impl Default for McpRateLimitConfig {
104 fn default() -> Self {
105 Self {
106 requests_per_minute: default_requests_per_minute(),
107 concurrent_requests: default_concurrent_requests(),
108 }
109 }
110}
111
112#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
114#[derive(Debug, Clone, Deserialize, Serialize)]
115pub struct McpValidationConfig {
116 #[serde(default = "default_schema_validation_enabled")]
118 pub schema_validation_enabled: bool,
119
120 #[serde(default = "default_path_traversal_protection_enabled")]
122 pub path_traversal_protection: bool,
123
124 #[serde(default = "default_max_argument_size")]
126 pub max_argument_size: u32,
127}
128
129impl Default for McpValidationConfig {
130 fn default() -> Self {
131 Self {
132 schema_validation_enabled: default_schema_validation_enabled(),
133 path_traversal_protection: default_path_traversal_protection_enabled(),
134 max_argument_size: default_max_argument_size(),
135 }
136 }
137}
138
139impl Default for McpClientConfig {
140 fn default() -> Self {
141 Self {
142 enabled: default_mcp_enabled(),
143 ui: McpUiConfig::default(),
144 providers: Vec::new(),
145 server: McpServerConfig::default(),
146 allowlist: McpAllowListConfig::default(),
147 max_concurrent_connections: default_max_concurrent_connections(),
148 request_timeout_seconds: default_request_timeout_seconds(),
149 retry_attempts: default_retry_attempts(),
150 startup_timeout_seconds: None,
151 tool_timeout_seconds: None,
152 experimental_use_rmcp_client: default_experimental_use_rmcp_client(),
153 security: McpSecurityConfig::default(),
154 }
155 }
156}
157
158#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
160#[derive(Debug, Clone, Deserialize, Serialize)]
161pub struct McpUiConfig {
162 #[serde(default = "default_mcp_ui_mode")]
164 pub mode: McpUiMode,
165
166 #[serde(default = "default_max_mcp_events")]
168 pub max_events: usize,
169
170 #[serde(default = "default_show_provider_names")]
172 pub show_provider_names: bool,
173
174 #[serde(default)]
176 pub renderers: HashMap<String, McpRendererProfile>,
177}
178
179impl Default for McpUiConfig {
180 fn default() -> Self {
181 Self {
182 mode: default_mcp_ui_mode(),
183 max_events: default_max_mcp_events(),
184 show_provider_names: default_show_provider_names(),
185 renderers: HashMap::new(),
186 }
187 }
188}
189
190impl McpUiConfig {
191 pub fn renderer_for_identifier(&self, identifier: &str) -> Option<McpRendererProfile> {
193 let normalized_identifier = normalize_mcp_identifier(identifier);
194 if normalized_identifier.is_empty() {
195 return None;
196 }
197
198 self.renderers.iter().find_map(|(key, profile)| {
199 let normalized_key = normalize_mcp_identifier(key);
200 if normalized_identifier.starts_with(&normalized_key) {
201 Some(*profile)
202 } else {
203 None
204 }
205 })
206 }
207
208 pub fn renderer_for_tool(&self, tool_name: &str) -> Option<McpRendererProfile> {
210 let identifier = tool_name.strip_prefix("mcp_").unwrap_or(tool_name);
211 self.renderer_for_identifier(identifier)
212 }
213}
214
215#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
217#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
218#[serde(rename_all = "snake_case")]
219#[derive(Default)]
220pub enum McpUiMode {
221 #[default]
223 Compact,
224 Full,
226}
227
228impl std::fmt::Display for McpUiMode {
229 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
230 match self {
231 McpUiMode::Compact => write!(f, "compact"),
232 McpUiMode::Full => write!(f, "full"),
233 }
234 }
235}
236
237#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
239#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
240#[serde(rename_all = "kebab-case")]
241pub enum McpRendererProfile {
242 Context7,
244 SequentialThinking,
246}
247
248#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
250#[derive(Debug, Clone, Deserialize, Serialize)]
251pub struct McpProviderConfig {
252 pub name: String,
254
255 #[serde(flatten)]
257 pub transport: McpTransportConfig,
258
259 #[serde(default)]
261 pub env: HashMap<String, String>,
262
263 #[serde(default = "default_provider_enabled")]
265 pub enabled: bool,
266
267 #[serde(default = "default_provider_max_concurrent")]
269 pub max_concurrent_requests: usize,
270
271 #[serde(default)]
273 pub startup_timeout_ms: Option<u64>,
274}
275
276impl Default for McpProviderConfig {
277 fn default() -> Self {
278 Self {
279 name: String::new(),
280 transport: McpTransportConfig::Stdio(McpStdioServerConfig::default()),
281 env: HashMap::new(),
282 enabled: default_provider_enabled(),
283 max_concurrent_requests: default_provider_max_concurrent(),
284 startup_timeout_ms: None,
285 }
286 }
287}
288
289#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
291#[derive(Debug, Clone, Deserialize, Serialize)]
292pub struct McpAllowListConfig {
293 #[serde(default = "default_allowlist_enforced")]
295 pub enforce: bool,
296
297 #[serde(default)]
299 pub default: McpAllowListRules,
300
301 #[serde(default)]
303 pub providers: BTreeMap<String, McpAllowListRules>,
304}
305
306impl Default for McpAllowListConfig {
307 fn default() -> Self {
308 Self {
309 enforce: default_allowlist_enforced(),
310 default: McpAllowListRules::default(),
311 providers: BTreeMap::new(),
312 }
313 }
314}
315
316impl McpAllowListConfig {
317 pub fn is_tool_allowed(&self, provider: &str, tool_name: &str) -> bool {
319 if !self.enforce {
320 return true;
321 }
322
323 self.resolve_match(provider, tool_name, |rules| &rules.tools)
324 }
325
326 pub fn is_resource_allowed(&self, provider: &str, resource: &str) -> bool {
328 if !self.enforce {
329 return true;
330 }
331
332 self.resolve_match(provider, resource, |rules| &rules.resources)
333 }
334
335 pub fn is_prompt_allowed(&self, provider: &str, prompt: &str) -> bool {
337 if !self.enforce {
338 return true;
339 }
340
341 self.resolve_match(provider, prompt, |rules| &rules.prompts)
342 }
343
344 pub fn is_logging_channel_allowed(&self, provider: Option<&str>, channel: &str) -> bool {
346 if !self.enforce {
347 return true;
348 }
349
350 if let Some(name) = provider
351 && let Some(rules) = self.providers.get(name)
352 && let Some(patterns) = &rules.logging
353 {
354 return pattern_matches(patterns, channel);
355 }
356
357 if let Some(patterns) = &self.default.logging
358 && pattern_matches(patterns, channel)
359 {
360 return true;
361 }
362
363 false
364 }
365
366 pub fn is_configuration_allowed(
368 &self,
369 provider: Option<&str>,
370 category: &str,
371 key: &str,
372 ) -> bool {
373 if !self.enforce {
374 return true;
375 }
376
377 if let Some(name) = provider
378 && let Some(rules) = self.providers.get(name)
379 && let Some(result) = configuration_allowed(rules, category, key)
380 {
381 return result;
382 }
383
384 if let Some(result) = configuration_allowed(&self.default, category, key) {
385 return result;
386 }
387
388 false
389 }
390
391 fn resolve_match<'a, F>(&'a self, provider: &str, candidate: &str, accessor: F) -> bool
392 where
393 F: Fn(&'a McpAllowListRules) -> &'a Option<Vec<String>>,
394 {
395 if let Some(rules) = self.providers.get(provider)
396 && let Some(patterns) = accessor(rules)
397 {
398 return pattern_matches(patterns, candidate);
399 }
400
401 if let Some(patterns) = accessor(&self.default)
402 && pattern_matches(patterns, candidate)
403 {
404 return true;
405 }
406
407 false
408 }
409}
410
411fn configuration_allowed(rules: &McpAllowListRules, category: &str, key: &str) -> Option<bool> {
412 rules.configuration.as_ref().and_then(|entries| {
413 entries
414 .get(category)
415 .map(|patterns| pattern_matches(patterns, key))
416 })
417}
418
419fn pattern_matches(patterns: &[String], candidate: &str) -> bool {
420 patterns
421 .iter()
422 .any(|pattern| wildcard_match(pattern, candidate))
423}
424
425fn wildcard_match(pattern: &str, candidate: &str) -> bool {
426 if pattern == "*" {
427 return true;
428 }
429
430 let mut regex_pattern = String::from("^");
431 let mut literal_buffer = String::new();
432
433 for ch in pattern.chars() {
434 match ch {
435 '*' => {
436 if !literal_buffer.is_empty() {
437 regex_pattern.push_str(®ex::escape(&literal_buffer));
438 literal_buffer.clear();
439 }
440 regex_pattern.push_str(".*");
441 }
442 '?' => {
443 if !literal_buffer.is_empty() {
444 regex_pattern.push_str(®ex::escape(&literal_buffer));
445 literal_buffer.clear();
446 }
447 regex_pattern.push('.');
448 }
449 _ => literal_buffer.push(ch),
450 }
451 }
452
453 if !literal_buffer.is_empty() {
454 regex_pattern.push_str(®ex::escape(&literal_buffer));
455 }
456
457 regex_pattern.push('$');
458
459 Regex::new(®ex_pattern)
460 .map(|regex| regex.is_match(candidate))
461 .unwrap_or(false)
462}
463
464#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
466#[derive(Debug, Clone, Deserialize, Serialize, Default)]
467pub struct McpAllowListRules {
468 #[serde(default)]
470 pub tools: Option<Vec<String>>,
471
472 #[serde(default)]
474 pub resources: Option<Vec<String>>,
475
476 #[serde(default)]
478 pub prompts: Option<Vec<String>>,
479
480 #[serde(default)]
482 pub logging: Option<Vec<String>>,
483
484 #[serde(default)]
486 pub configuration: Option<BTreeMap<String, Vec<String>>>,
487}
488
489#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
491#[derive(Debug, Clone, Deserialize, Serialize)]
492pub struct McpServerConfig {
493 #[serde(default = "default_mcp_server_enabled")]
495 pub enabled: bool,
496
497 #[serde(default = "default_mcp_server_bind")]
499 pub bind_address: String,
500
501 #[serde(default = "default_mcp_server_port")]
503 pub port: u16,
504
505 #[serde(default = "default_mcp_server_transport")]
507 pub transport: McpServerTransport,
508
509 #[serde(default = "default_mcp_server_name")]
511 pub name: String,
512
513 #[serde(default = "default_mcp_server_version")]
515 pub version: String,
516
517 #[serde(default)]
519 pub exposed_tools: Vec<String>,
520}
521
522impl Default for McpServerConfig {
523 fn default() -> Self {
524 Self {
525 enabled: default_mcp_server_enabled(),
526 bind_address: default_mcp_server_bind(),
527 port: default_mcp_server_port(),
528 transport: default_mcp_server_transport(),
529 name: default_mcp_server_name(),
530 version: default_mcp_server_version(),
531 exposed_tools: Vec::new(),
532 }
533 }
534}
535
536#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
538#[derive(Debug, Clone, Deserialize, Serialize)]
539#[serde(rename_all = "snake_case")]
540#[derive(Default)]
541pub enum McpServerTransport {
542 #[default]
544 Sse,
545 Http,
547}
548
549#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
551#[derive(Debug, Clone, Deserialize, Serialize)]
552#[serde(untagged)]
553pub enum McpTransportConfig {
554 Stdio(McpStdioServerConfig),
556 Http(McpHttpServerConfig),
558}
559
560#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
562#[derive(Debug, Clone, Deserialize, Serialize, Default)]
563pub struct McpStdioServerConfig {
564 pub command: String,
566
567 pub args: Vec<String>,
569
570 #[serde(default)]
572 pub working_directory: Option<String>,
573}
574
575#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
581#[derive(Debug, Clone, Deserialize, Serialize)]
582pub struct McpHttpServerConfig {
583 pub endpoint: String,
585
586 #[serde(default)]
588 pub api_key_env: Option<String>,
589
590 #[serde(default = "default_mcp_protocol_version")]
592 pub protocol_version: String,
593
594 #[serde(default)]
596 pub headers: HashMap<String, String>,
597}
598
599impl Default for McpHttpServerConfig {
600 fn default() -> Self {
601 Self {
602 endpoint: String::new(),
603 api_key_env: None,
604 protocol_version: default_mcp_protocol_version(),
605 headers: HashMap::new(),
606 }
607 }
608}
609
610fn default_mcp_enabled() -> bool {
612 false
613}
614
615fn default_mcp_ui_mode() -> McpUiMode {
616 McpUiMode::Compact
617}
618
619fn default_max_mcp_events() -> usize {
620 50
621}
622
623fn default_show_provider_names() -> bool {
624 true
625}
626
627fn default_max_concurrent_connections() -> usize {
628 5
629}
630
631fn default_request_timeout_seconds() -> u64 {
632 30
633}
634
635fn default_retry_attempts() -> u32 {
636 3
637}
638
639fn default_experimental_use_rmcp_client() -> bool {
640 true
641}
642
643fn default_provider_enabled() -> bool {
644 true
645}
646
647fn default_provider_max_concurrent() -> usize {
648 3
649}
650
651fn default_allowlist_enforced() -> bool {
652 false
653}
654
655fn default_mcp_protocol_version() -> String {
656 "2024-11-05".to_string()
657}
658
659fn default_mcp_server_enabled() -> bool {
660 false
661}
662
663fn default_mcp_server_bind() -> String {
664 "127.0.0.1".to_string()
665}
666
667fn default_mcp_server_port() -> u16 {
668 3000
669}
670
671fn default_mcp_server_transport() -> McpServerTransport {
672 McpServerTransport::Sse
673}
674
675fn default_mcp_server_name() -> String {
676 "vtcode-mcp-server".to_string()
677}
678
679fn default_mcp_server_version() -> String {
680 env!("CARGO_PKG_VERSION").to_string()
681}
682
683fn normalize_mcp_identifier(value: &str) -> String {
684 value
685 .chars()
686 .filter(|ch| ch.is_ascii_alphanumeric())
687 .map(|ch| ch.to_ascii_lowercase())
688 .collect()
689}
690
691fn default_mcp_auth_enabled() -> bool {
692 false
693}
694
695fn default_requests_per_minute() -> u32 {
696 100
697}
698
699fn default_concurrent_requests() -> u32 {
700 10
701}
702
703fn default_schema_validation_enabled() -> bool {
704 true
705}
706
707fn default_path_traversal_protection_enabled() -> bool {
708 true
709}
710
711fn default_max_argument_size() -> u32 {
712 1024 * 1024 }
714
715#[cfg(test)]
716mod tests {
717 use super::*;
718 use crate::constants::mcp as mcp_constants;
719 use std::collections::BTreeMap;
720
721 #[test]
722 fn test_mcp_config_defaults() {
723 let config = McpClientConfig::default();
724 assert!(!config.enabled);
725 assert_eq!(config.ui.mode, McpUiMode::Compact);
726 assert_eq!(config.ui.max_events, 50);
727 assert!(config.ui.show_provider_names);
728 assert!(config.ui.renderers.is_empty());
729 assert_eq!(config.max_concurrent_connections, 5);
730 assert_eq!(config.request_timeout_seconds, 30);
731 assert_eq!(config.retry_attempts, 3);
732 assert!(config.providers.is_empty());
733 assert!(!config.server.enabled);
734 assert!(!config.allowlist.enforce);
735 assert!(config.allowlist.default.tools.is_none());
736 }
737
738 #[test]
739 fn test_allowlist_pattern_matching() {
740 let patterns = vec!["get_*".to_string(), "convert_timezone".to_string()];
741 assert!(pattern_matches(&patterns, "get_current_time"));
742 assert!(pattern_matches(&patterns, "convert_timezone"));
743 assert!(!pattern_matches(&patterns, "delete_timezone"));
744 }
745
746 #[test]
747 fn test_allowlist_provider_override() {
748 let mut config = McpAllowListConfig::default();
749 config.enforce = true;
750 config.default.tools = Some(vec!["get_*".to_string()]);
751
752 let mut provider_rules = McpAllowListRules::default();
753 provider_rules.tools = Some(vec!["list_*".to_string()]);
754 config
755 .providers
756 .insert("context7".to_string(), provider_rules);
757
758 assert!(config.is_tool_allowed("context7", "list_documents"));
759 assert!(!config.is_tool_allowed("context7", "get_current_time"));
760 assert!(config.is_tool_allowed("other", "get_timezone"));
761 assert!(!config.is_tool_allowed("other", "list_documents"));
762 }
763
764 #[test]
765 fn test_allowlist_configuration_rules() {
766 let mut config = McpAllowListConfig::default();
767 config.enforce = true;
768
769 let mut default_rules = McpAllowListRules::default();
770 default_rules.configuration = Some(BTreeMap::from([(
771 "ui".to_string(),
772 vec!["mode".to_string(), "max_events".to_string()],
773 )]));
774 config.default = default_rules;
775
776 let mut provider_rules = McpAllowListRules::default();
777 provider_rules.configuration = Some(BTreeMap::from([(
778 "provider".to_string(),
779 vec!["max_concurrent_requests".to_string()],
780 )]));
781 config.providers.insert("time".to_string(), provider_rules);
782
783 assert!(config.is_configuration_allowed(None, "ui", "mode"));
784 assert!(!config.is_configuration_allowed(None, "ui", "show_provider_names"));
785 assert!(config.is_configuration_allowed(
786 Some("time"),
787 "provider",
788 "max_concurrent_requests"
789 ));
790 assert!(!config.is_configuration_allowed(Some("time"), "provider", "retry_attempts"));
791 }
792
793 #[test]
794 fn test_allowlist_resource_override() {
795 let mut config = McpAllowListConfig::default();
796 config.enforce = true;
797 config.default.resources = Some(vec!["docs/*".to_string()]);
798
799 let mut provider_rules = McpAllowListRules::default();
800 provider_rules.resources = Some(vec!["journals/*".to_string()]);
801 config
802 .providers
803 .insert("context7".to_string(), provider_rules);
804
805 assert!(config.is_resource_allowed("context7", "journals/2024"));
806 assert!(!config.is_resource_allowed("context7", "docs/manual"));
807 assert!(config.is_resource_allowed("other", "docs/reference"));
808 assert!(!config.is_resource_allowed("other", "journals/2023"));
809 }
810
811 #[test]
812 fn test_allowlist_logging_override() {
813 let mut config = McpAllowListConfig::default();
814 config.enforce = true;
815 config.default.logging = Some(vec!["info".to_string(), "debug".to_string()]);
816
817 let mut provider_rules = McpAllowListRules::default();
818 provider_rules.logging = Some(vec!["audit".to_string()]);
819 config
820 .providers
821 .insert("sequential".to_string(), provider_rules);
822
823 assert!(config.is_logging_channel_allowed(Some("sequential"), "audit"));
824 assert!(!config.is_logging_channel_allowed(Some("sequential"), "info"));
825 assert!(config.is_logging_channel_allowed(Some("other"), "info"));
826 assert!(!config.is_logging_channel_allowed(Some("other"), "trace"));
827 }
828
829 #[test]
830 fn test_mcp_ui_renderer_resolution() {
831 let mut config = McpUiConfig::default();
832 config.renderers.insert(
833 mcp_constants::RENDERER_CONTEXT7.to_string(),
834 McpRendererProfile::Context7,
835 );
836 config.renderers.insert(
837 mcp_constants::RENDERER_SEQUENTIAL_THINKING.to_string(),
838 McpRendererProfile::SequentialThinking,
839 );
840
841 assert_eq!(
842 config.renderer_for_tool("mcp_context7_lookup"),
843 Some(McpRendererProfile::Context7)
844 );
845 assert_eq!(
846 config.renderer_for_tool("mcp_context7lookup"),
847 Some(McpRendererProfile::Context7)
848 );
849 assert_eq!(
850 config.renderer_for_tool("mcp_sequentialthinking_run"),
851 Some(McpRendererProfile::SequentialThinking)
852 );
853 assert_eq!(
854 config.renderer_for_identifier("sequential-thinking-analyze"),
855 Some(McpRendererProfile::SequentialThinking)
856 );
857 assert_eq!(config.renderer_for_tool("mcp_unknown"), None);
858 }
859}