memgraph-toolbox 0.1.7

Memgraph toolbox library for Memgraph AI tools and utilities

Memgraph Toolbox

The Memgraph Toolbox is a collection of tools designed to interact with a Memgraph database. These tools provide functionality for querying, analyzing, and managing data within Memgraph, making it easier to work with graph data. They are made to be easily called from other frameworks such as MCP, LangChain or LlamaIndex.

Available Tools

Below is a list of tools included in the toolbox, along with their descriptions:

1. ShowTriggersTool - Shows trigger information from a Memgraph database.
2. ShowStorageInfoTool - Shows storage information from a Memgraph database.
3. ShowSchemaInfoTool - Shows schema information from a Memgraph database.
4. PageRankTool - Calculates PageRank on a graph in Memgraph.
5. BetweennessCentralityTool - Calculates betweenness centrality for nodes in a graph.
6. ShowIndexInfoTool - Shows index information from a Memgraph database.
7. CypherTool - Executes arbitrary Cypher queries on a Memgraph database.
8. ShowConstraintInfoTool - Shows constraint information from a Memgraph database.
9. ShowConfigTool - Shows configuration information from a Memgraph database.
10. NodeVectorSearchTool - Searches the most similar nodes using the Memgraph's vector search.
11. NodeNeighborhoodTool - Searches for the data attached to a given node using Memgraph's deep-path traversals.

Usage

Each tool is implemented as a Python class inheriting from BaseTool. To use a tool:

1. Instantiate the tool with a Memgraph database connection.
2. Call the call method with the required arguments.

Example:

from memgraph_toolbox.tools.trigger import ShowTriggersTool
from memgraph_toolbox.api.memgraph import Memgraph
from memgraph_toolbox.memgraph_toolbox import MemgraphToolbox

# Connect to Memgraph
db = Memgraph(url="bolt://localhost:7687", username="", password="")

# Show available tools
toolbox = MemgraphToolbox(db)
for tool in toolbox.get_all_tools():
    print(f"Tool Name: {tool.name}, Description: {tool.description}")

# Use the ShowTriggersTool
tool = ShowTriggersTool(db)
triggers = tool.call({})
print(triggers)

Installation

Install the base package:

pip install memgraph-toolbox

If you need embedding utilities or evaluation metrics that depend on PyTorch and sentence-transformers:

pip install 'memgraph-toolbox[evaluations]'

Requirements

• Python 3.10+
• Running Memgraph instance
• Memgraph MAGE library (for certain tools like pagerank and run_betweenness_centrality)
• Optional: PyTorch and sentence-transformers (install with evaluations extra) for embedding utilities and coherence evaluation

Contributing

Contributions are welcome! Feel free to submit issues or pull requests to improve the toolbox.

License

This project is licensed under the MIT License. See the LICENSE file for details.