memgraph-toolbox


Namememgraph-toolbox JSON
Version 0.1.4 PyPI version JSON
download
home_pageNone
SummaryMemgraph toolbox library for Memgraph AI tools and utilities
upload_time2025-08-06 11:28:20
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT
keywords ai graph memgraph toolkit
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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](https://memgraph.com/docs/fundamentals/triggers) information from a Memgraph database.
2. `ShowStorageInfoTool` - Shows storage information from a Memgraph database.
3. `ShowSchemaInfoTool` - Shows [schema](https://memgraph.com/docs/querying/schema) information from a Memgraph database.
4. `PageRankTool` - Calculates [PageRank](https://memgraph.com/docs/advanced-algorithms/available-algorithms/pagerank) on a graph in Memgraph.
5. `BetweennessCentralityTool` - Calculates [betweenness centrality](https://memgraph.com/docs/advanced-algorithms/available-algorithms/betweenness_centrality) for nodes in a graph.
6. `ShowIndexInfoTool` - Shows [index](https://memgraph.com/docs/fundamentals/indexes) information from a Memgraph database.
7. `CypherTool` - Executes arbitrary [Cypher queries](https://memgraph.com/docs/querying) on a Memgraph database.
8. `ShowConstraintInfoTool` - Shows [constraint](https://memgraph.com/docs/fundamentals/constraints) information from a Memgraph database.
9. `ShowConfigTool` - Shows [configuration](https://memgraph.com/docs/database-management/configuration) information from a Memgraph database.

## 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:

```python
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)
```

## Requirements

- Python 3.10+
- Running [Memgraph instance](https://memgraph.com/docs/getting-started)
- Memgraph [MAGE library](https://memgraph.com/docs/advanced-algorithms/install-mage) (for certain tools like `pagerank` and `run_betweenness_centrality`)

## 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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "memgraph-toolbox",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "ai, graph, memgraph, toolkit",
    "author": null,
    "author_email": "antejavor <ante.javor@memgraph.io>",
    "download_url": "https://files.pythonhosted.org/packages/f3/27/25d29e2cbd3a1d9969b8b1ec7a7fded05f05d5db883eadeb0840444df509/memgraph_toolbox-0.1.4.tar.gz",
    "platform": null,
    "description": "# Memgraph Toolbox\n\nThe **Memgraph Toolbox** is a collection of tools designed to interact with a\nMemgraph database. These tools provide functionality for querying, analyzing,\nand managing data within Memgraph, making it easier to work with graph data.\nThey are made to be easily called from other frameworks such as\n**MCP**, **LangChain** or **LlamaIndex**.\n\n## Available Tools\n\nBelow is a list of tools included in the toolbox, along with their descriptions:\n\n1. `ShowTriggersTool` - Shows [trigger](https://memgraph.com/docs/fundamentals/triggers) information from a Memgraph database.\n2. `ShowStorageInfoTool` - Shows storage information from a Memgraph database.\n3. `ShowSchemaInfoTool` - Shows [schema](https://memgraph.com/docs/querying/schema) information from a Memgraph database.\n4. `PageRankTool` - Calculates [PageRank](https://memgraph.com/docs/advanced-algorithms/available-algorithms/pagerank) on a graph in Memgraph.\n5. `BetweennessCentralityTool` - Calculates [betweenness centrality](https://memgraph.com/docs/advanced-algorithms/available-algorithms/betweenness_centrality) for nodes in a graph.\n6. `ShowIndexInfoTool` - Shows [index](https://memgraph.com/docs/fundamentals/indexes) information from a Memgraph database.\n7. `CypherTool` - Executes arbitrary [Cypher queries](https://memgraph.com/docs/querying) on a Memgraph database.\n8. `ShowConstraintInfoTool` - Shows [constraint](https://memgraph.com/docs/fundamentals/constraints) information from a Memgraph database.\n9. `ShowConfigTool` - Shows [configuration](https://memgraph.com/docs/database-management/configuration) information from a Memgraph database.\n\n## Usage\n\nEach tool is implemented as a Python class inheriting from `BaseTool`. To use a\ntool:\n\n1. Instantiate the tool with a `Memgraph` database connection.\n2. Call the `call` method with the required arguments.\n\nExample:\n\n```python\nfrom memgraph_toolbox.tools.trigger import ShowTriggersTool\nfrom memgraph_toolbox.api.memgraph import Memgraph\nfrom memgraph_toolbox.memgraph_toolbox import MemgraphToolbox\n\n# Connect to Memgraph\ndb = Memgraph(url=\"bolt://localhost:7687\", username=\"\", password=\"\")\n\n# Show available tools\ntoolbox = MemgraphToolbox(db)\nfor tool in toolbox.get_all_tools():\n    print(f\"Tool Name: {tool.name}, Description: {tool.description}\")\n\n# Use the ShowTriggersTool\ntool = ShowTriggersTool(db)\ntriggers = tool.call({})\nprint(triggers)\n```\n\n## Requirements\n\n- Python 3.10+\n- Running [Memgraph instance](https://memgraph.com/docs/getting-started)\n- Memgraph [MAGE library](https://memgraph.com/docs/advanced-algorithms/install-mage) (for certain tools like `pagerank` and `run_betweenness_centrality`)\n\n## Contributing\n\nContributions are welcome! Feel free to submit issues or pull requests to\nimprove the toolbox.\n\n## License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for\ndetails.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Memgraph toolbox library for Memgraph AI tools and utilities",
    "version": "0.1.4",
    "project_urls": {
        "Homepage": "https://github.com/memgraph/ai-toolkit",
        "Issues": "https://github.com/memgraph/ai-toolkit/issues",
        "Source": "https://github.com/memgraph/ai-toolkit"
    },
    "split_keywords": [
        "ai",
        " graph",
        " memgraph",
        " toolkit"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e190ac0d6f724acbe10287ce4b081dff65bc8135911b83e434aa4d3a55521357",
                "md5": "c213b80bd116d8de777fbfa6a4f6020a",
                "sha256": "d93395304f2bd9aa8440c5419e4c23dcd97b6e99cf48e3fc01ec9ce61a17e874"
            },
            "downloads": -1,
            "filename": "memgraph_toolbox-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c213b80bd116d8de777fbfa6a4f6020a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 16913,
            "upload_time": "2025-08-06T11:28:19",
            "upload_time_iso_8601": "2025-08-06T11:28:19.490089Z",
            "url": "https://files.pythonhosted.org/packages/e1/90/ac0d6f724acbe10287ce4b081dff65bc8135911b83e434aa4d3a55521357/memgraph_toolbox-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f32725d29e2cbd3a1d9969b8b1ec7a7fded05f05d5db883eadeb0840444df509",
                "md5": "51fa6bbd35da6524717d2174d2c2c8dd",
                "sha256": "c80925c6f5f3a57a7cb4e8a57355e3b228be762e0b1d5bc0f81e335c7d0a57e4"
            },
            "downloads": -1,
            "filename": "memgraph_toolbox-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "51fa6bbd35da6524717d2174d2c2c8dd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 16581,
            "upload_time": "2025-08-06T11:28:20",
            "upload_time_iso_8601": "2025-08-06T11:28:20.661866Z",
            "url": "https://files.pythonhosted.org/packages/f3/27/25d29e2cbd3a1d9969b8b1ec7a7fded05f05d5db883eadeb0840444df509/memgraph_toolbox-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-06 11:28:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "memgraph",
    "github_project": "ai-toolkit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "memgraph-toolbox"
}
        
Elapsed time: 1.42315s