Skip to main content

Memgraph toolbox library for Memgraph AI tools and utilities

Project description

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

Optional dependencies

For the MCP prompt client (litellm + mcp):

pip install 'memgraph-toolbox[client]'

For evaluation metrics (deepeval, sentence-transformers, torch):

pip install 'memgraph-toolbox[evaluations]'

For running tests:

pip install 'memgraph-toolbox[test]'

For all optional dependencies (e.g., CI):

pip install 'memgraph-toolbox[client,evaluations,test]'

Requirements

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

memgraph_toolbox-0.1.9.tar.gz (190.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

memgraph_toolbox-0.1.9-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

Details for the file memgraph_toolbox-0.1.9.tar.gz.

File metadata

  • Download URL: memgraph_toolbox-0.1.9.tar.gz
  • Upload date:
  • Size: 190.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.5

File hashes

Hashes for memgraph_toolbox-0.1.9.tar.gz
Algorithm Hash digest
SHA256 1cbc39caba3e57fb30844933ded8a36712d75c3e62d95a7ba104f472a0c73c71
MD5 0b244718cf989f6bfdfd3ec5533b4d51
BLAKE2b-256 552b7aef0308c873cf3a9b5c165efa9a926a130e0428138e92ea928055ff9ef3

See more details on using hashes here.

File details

Details for the file memgraph_toolbox-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for memgraph_toolbox-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 3ebeb791c0002510dfce3ef51da18a8b6a5d110c8d82147a7390a0811eed4f70
MD5 e9c763f97c0dace2034d3c8283bb4aa6
BLAKE2b-256 2e9b9e33773bd4a9ab0956367235fbd847cf4085397b19a2f0a79a5af1cff250

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page