Skip to main content

一个提供Neo4j数据库操作功能的Model Context Protocol服务器

Project description

Neo4j MCP 服务器

一个基于 Model Context Protocol 的 Neo4j 图数据库操作服务器。该服务器使 LLM 能够执行 Neo4j 数据库操作,包括运行 Cypher 查询和获取数据库元信息。

可用工具

  • run_query - 执行 Cypher 查询语句

    • 必需参数:
      • query (字符串): Cypher 查询语句
    • 可选参数:
      • parameters (对象): 查询参数
  • get_database_info - 获取 Neo4j 数据库信息

    • 无需参数
  • get_node_labels - 获取数据库中所有节点标签

    • 无需参数
  • get_relationship_types - 获取数据库中所有关系类型

    • 无需参数
  • get_node_properties - 获取指定标签节点的属性信息

    • 必需参数:
      • label (字符串): 节点标签名称

安装

使用 uv (推荐)

当使用 uv 时,不需要特定安装。我们将使用 uvx 直接运行 mcp-server-neo4j

使用 PIP

您也可以通过 pip 安装 mcp-server-neo4j:

pip install mcp-server-neo4j

安装后,您可以通过以下命令运行:

python -m mcp_server_neo4j

Docker 构建

cd src/neo4j
docker build -t mcp/neo4j .

配置

配置 Claude.app

在 Claude 设置中添加:

使用 uvx
"mcpServers": {
  "neo4j": {
    "command": "uvx",
    "args": ["mcp-server-neo4j", "--uri=bolt://neo4j-server:7687", "--username=neo4j", "--password=your_password"]
  }
}
使用 docker
"mcpServers": {
  "neo4j": {
    "command": "docker",
    "args": ["run", "-i", "--rm", "mcp/neo4j", "--uri=bolt://neo4j-server:7687", "--username=neo4j", "--password=your_password"]
  }
}
使用 pip 安装
"mcpServers": {
  "neo4j": {
    "command": "python",
    "args": ["-m", "mcp_server_neo4j", "--uri=bolt://neo4j-server:7687", "--username=neo4j", "--password=your_password"]
  }
}

配置 Zed

在 Zed 的 settings.json 中添加:

使用 uvx
"context_servers": [
  "mcp-server-neo4j": {
    "command": "uvx",
    "args": ["mcp-server-neo4j", "--uri=bolt://neo4j-server:7687", "--username=neo4j", "--password=your_password"]
  }
],
使用 pip 安装
"context_servers": {
  "mcp-server-neo4j": {
    "command": "python",
    "args": ["-m", "mcp_server_neo4j", "--uri=bolt://neo4j-server:7687", "--username=neo4j", "--password=your_password"]
  }
},

调试

您可以使用 MCP inspector 来调试服务器。对于 uvx 安装:

npx @modelcontextprotocol/inspector uvx mcp-server-neo4j

或者,如果您在特定目录中安装了该包或正在开发:

cd path/to/servers/src/neo4j
npx @modelcontextprotocol/inspector uv run mcp-server-neo4j

示例交互

  1. 执行 Cypher 查询:
{
  "name": "run_query",
  "arguments": {
    "query": "MATCH (n:Person) RETURN n.name, n.age LIMIT 10"
  }
}

响应:

{
  "data": [
    {
      "n.name": "张三",
      "n.age": 30
    },
    {
      "n.name": "李四",
      "n.age": 25
    }
  ],
  "summary": {
    "counters": {
      "nodes_created": 0,
      "nodes_deleted": 0,
      "relationships_created": 0,
      "relationships_deleted": 0,
      "properties_set": 0,
      "labels_added": 0,
      "labels_removed": 0,
      "indexes_added": 0,
      "indexes_removed": 0,
      "constraints_added": 0,
      "constraints_removed": 0
    }
  }
}
  1. 获取数据库信息:
{
  "name": "get_database_info",
  "arguments": {}
}

响应:

{
  "name": "Neo4j",
  "version": "5.14.0",
  "node_count": 1000,
  "relationship_count": 5000,
  "labels": ["Person", "Movie", "Director"],
  "relationship_types": ["ACTED_IN", "DIRECTED", "FRIEND_OF"]
}

Claude 使用示例问题

  1. "你能帮我查询图数据库中的所有人物节点吗?"
  2. "请告诉我数据库中有哪些类型的节点标签和关系"
  3. "执行查询,找出所有演员和他们参演的电影"
  4. "Person 节点有哪些属性?"

贡献

我们鼓励您对 mcp-server-neo4j 进行贡献。无论您想添加新的 Neo4j 相关工具、增强现有功能,还是改进文档,您的贡献都是宝贵的。

有关其他 MCP 服务器和实现模式的示例,请参阅: https://github.com/modelcontextprotocol/servers

欢迎提交拉取请求!欢迎贡献新想法、错误修复或增强功能,以使 mcp-server-neo4j 更加强大和有用。

许可证

mcp-server-neo4j 遵循 MIT 许可证。这意味着您可以自由使用、修改和分发该软件,但须遵守 MIT 许可证的条款和条件。有关更多详细信息,请参阅项目代码库中的 LICENSE 文件。

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

mcp_server_neo4j-0.1.4.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

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

mcp_server_neo4j-0.1.4-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_neo4j-0.1.4.tar.gz.

File metadata

  • Download URL: mcp_server_neo4j-0.1.4.tar.gz
  • Upload date:
  • Size: 27.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for mcp_server_neo4j-0.1.4.tar.gz
Algorithm Hash digest
SHA256 eb56a2eab86acda69b3f9cdf341b4f86c9ce0fcb68bd92b6b7604c05f772435c
MD5 b63e6ff8255260b6f320fc55b115405e
BLAKE2b-256 868cf4562591b8459ab78809a6cd1f268aec2de5bf94d0542e4e0c1f1eb1dcc8

See more details on using hashes here.

File details

Details for the file mcp_server_neo4j-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_neo4j-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 db4bd6ff72f1b9319e70f434a2e0e6744283cd39b555eef02308c6c2207d8b80
MD5 12421f1660420416ae5d61c6cb92d854
BLAKE2b-256 19f30a856c2166ba7dd292098a3964eae0d2b2ed20d18ced2e1bf4957871daf5

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