Skip to main content

mcp_memory/
tools.rs

1pub struct ToolMeta {
2    pub name: &'static str,
3    pub write: bool,
4}
5
6pub const ALL_TOOLS: &[ToolMeta] = &[
7    ToolMeta { name: "create_entities",    write: true  },
8    ToolMeta { name: "create_relations",   write: true  },
9    ToolMeta { name: "add_observations",   write: true  },
10    ToolMeta { name: "delete_entities",    write: true  },
11    ToolMeta { name: "delete_observations",write: true  },
12    ToolMeta { name: "delete_relations",   write: true  },
13    ToolMeta { name: "read_graph",         write: false },
14    ToolMeta { name: "search_nodes",       write: false },
15    ToolMeta { name: "open_nodes",         write: false },
16    ToolMeta { name: "get_entity",         write: false },
17    ToolMeta { name: "graph_stats",        write: false },
18    ToolMeta { name: "search_relations",   write: false },
19    ToolMeta { name: "find_path",          write: false },
20    ToolMeta { name: "compact",            write: true  },
21    ToolMeta { name: "get_neighbors",      write: false },
22    ToolMeta { name: "describe_entity",    write: false },
23    ToolMeta { name: "list_entity_types",  write: false },
24    ToolMeta { name: "list_relation_types",write: false },
25    ToolMeta { name: "upsert_entities",    write: true  },
26    ToolMeta { name: "export_graph",       write: false },
27    ToolMeta { name: "merge_entities",    write: true  },
28    ToolMeta { name: "extract_subgraph",  write: false },
29    ToolMeta { name: "batch_get_entities",write: false },
30    ToolMeta { name: "find_all_paths",    write: false },
31];
32
33#[inline]
34pub fn tool_exists(name: &str) -> bool {
35    ALL_TOOLS.iter().any(|t| t.name == name)
36}
37
38#[inline]
39pub fn is_write_tool(name: &str) -> bool {
40    ALL_TOOLS.iter().find(|t| t.name == name).map(|t| t.write).unwrap_or(false)
41}
42
43#[cfg(test)]
44mod tests {
45    use super::*;
46
47    #[test]
48    fn test_tool_exists_known() {
49        assert!(tool_exists("create_entities"));
50        assert!(tool_exists("read_graph"));
51        assert!(tool_exists("search_nodes"));
52    }
53
54    #[test]
55    fn test_tool_exists_unknown() {
56        assert!(!tool_exists("nonexistent_tool"));
57    }
58
59    #[test]
60    fn test_is_write_tool() {
61        assert!(is_write_tool("create_entities"));
62        assert!(is_write_tool("delete_entities"));
63        assert!(!is_write_tool("read_graph"));
64        assert!(!is_write_tool("search_nodes"));
65    }
66
67    #[test]
68    fn test_all_tools_unique() {
69        let mut names: Vec<&str> = ALL_TOOLS.iter().map(|t| t.name).collect();
70        names.sort();
71        names.dedup();
72        assert_eq!(names.len(), ALL_TOOLS.len(), "Duplicate tool names");
73    }
74
75    #[test]
76    fn test_tools_json_matches_all_tools() {
77        let tools_json = include_str!("../tools.json");
78        let parsed: Vec<serde_json::Value> =
79            serde_json::from_str(tools_json).expect("tools.json must be valid JSON");
80
81        let mut json_names: Vec<&str> = parsed
82            .iter()
83            .map(|t| t["name"].as_str().expect("each tool needs a name"))
84            .collect();
85        let mut meta_names: Vec<&str> = ALL_TOOLS.iter().map(|t| t.name).collect();
86        json_names.sort_unstable();
87        meta_names.sort_unstable();
88
89        assert_eq!(
90            json_names, meta_names,
91            "tools.json and ALL_TOOLS must declare the same tool names"
92        );
93    }
94}