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.8.tar.gz (189.5 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.8-py3-none-any.whl (30.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for memgraph_toolbox-0.1.8.tar.gz
Algorithm Hash digest
SHA256 d616e99fdb31c48f4fe62097257a3360e192e28ef5abbbdd1f8a76be79fc4c31
MD5 de3706882ec6d47a7afe66f7c2448ef7
BLAKE2b-256 50822ee10566914c8e4e03be9a80cd9f44df61e624a7c88fe2e928d11a4f33ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for memgraph_toolbox-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 1bc139fa0be379adf6d0d70e4ca64fcc06a28c8244db3816968b061dd4cf5b35
MD5 9c31977b2a17e8cb5b43308959a457b4
BLAKE2b-256 29a46e2c6e33ca4a82ad351558aeba2e438c964cbd5ffb623f1d813b75f30278

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