Merge branch 'main' into 75-schema-incl-rel-properties

jexp · web-flow · commit c6cf09014716 · 2025-07-14T12:53:54.000+02:00
diff --git a/.github/workflows/generate-upload-dxt-cypher.yml b/.github/workflows/generate-upload-dxt-cypher.yml
@@ -0,0 +1,75 @@
+name: MCP Neo4j Cypher Generate and Upload DXT File
+
+on:
+  push:
+    tags:
+      - mcp-neo4j-cypher-v*
+  workflow_dispatch:  # Allows manual triggering of the workflow
+    inputs:
+      release_tag:
+        description: 'Release tag to add .dxt file to (e.g., mcp-neo4j-cypher-v1.0.0)'
+        required: true
+        type: string
+
+permissions:
+  contents: write
+
+jobs:
+  generate-dxt:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Determine tag name
+        id: tag
+        run: |
+          if [ "${{ github.event_name }}" = "push" ]; then
+            TAG_NAME="${{ github.ref_name }}"
+            echo "Tag from push event: $TAG_NAME"
+          else
+            TAG_NAME="${{ github.event.inputs.release_tag }}"
+            echo "Tag from manual input: $TAG_NAME"
+          fi
+          echo "tag_name=$TAG_NAME" >> $GITHUB_OUTPUT
+
+      - name: Checkout code at specific tag
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ steps.tag.outputs.tag_name }}
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "servers/mcp-neo4j-cypher/pyproject.toml"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Setup Node.js for dxt
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Install Anthropic dxt
+        run: npm install -g @anthropic-ai/dxt
+
+      - name: Setup Python environment and dependencies with uv
+        run: |
+          cd servers/mcp-neo4j-cypher/
+          uv sync
+          # Install the package in development mode
+          uv pip install -e .
+
+      - name: Generate .dxt file
+        run: |
+          cd servers/mcp-neo4j-cypher/
+  
+          echo "Running dxt pack with uv..."
+          uv run dxt pack .
+
+      - name: Upload .dxt file to release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release upload "${{ steps.tag.outputs.tag_name }}" \
+            servers/mcp-neo4j-cypher/*.dxt \
+            --clobber
diff --git a/servers/mcp-neo4j-cypher/CHANGELOG.md b/servers/mcp-neo4j-cypher/CHANGELOG.md
@@ -3,8 +3,12 @@
 ### Fixed
 
 ### Changed
+* Update error handling in read and write tools
 
 ### Added
+* Add .dxt file for Cypher MCP server
+* Add .dxt file generation to Cypher MCP Publish GitHub action
+* Add error indicator to tool results in the `CallToolResult` object
 
 ## v0.2.4
 
diff --git a/servers/mcp-neo4j-cypher/README.md b/servers/mcp-neo4j-cypher/README.md
@@ -39,6 +39,12 @@ This is useful when you need to connect to multiple Neo4j databases or instances
 
 ## 🔧 Usage with Claude Desktop
 
+### Using DXT
+Download the latest `.dxt` file from the [releases page](https://github.com/neo4j-contrib/mcp-neo4j/releases/latest) and install it with your MCP client.
+
+Or use this direct link:
+[Download mcp-neo4j-cypher.dxt](https://github.com/neo4j-contrib/mcp-neo4j/releases/latest/download/mcp-neo4j-cypher.dxt)
+
 ### 💾 Released Package
 
 Can be found on PyPi https://pypi.org/project/mcp-neo4j-cypher/
diff --git a/servers/mcp-neo4j-cypher/manifest.json b/servers/mcp-neo4j-cypher/manifest.json
@@ -0,0 +1,120 @@
+{
+  "dxt_version": "0.1",
+  "name": "mcp-neo4j-cypher",
+  "display_name": "Neo4j Cypher MCP Server",
+  "version": "0.2.4",
+  "description": "Execute read and write Cypher queries on your Neo4j database.",
+  "long_description": "A Model Context Protocol (MCP) server that provides tools for interacting with Neo4j graph databases using Cypher queries. Supports both read and write operations with proper validation and error handling.",
+  "author": {
+    "name": "Alexander Gilmore"
+  },
+  "keywords": ["neo4j", "cypher", "graph", "database", "mcp", "ai", "llm"],
+  "categories": ["database", "graph", "query"],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/neo4j-contrib/mcp-neo4j/tree/main/servers/mcp-neo4j-cypher"
+  },
+  "documentation": "https://github.com/neo4j-contrib/mcp-neo4j/blob/main/servers/mcp-neo4j-cypher/README.md",
+  "support": "https://github.com/neo4j-contrib/mcp-neo4j/issues",
+  "server": {
+    "type": "python",
+    "entry_point": "src/mcp_neo4j_cypher/__init__.py",
+    "mcp_config": {
+      "command": "uvx",
+      "args": ["mcp-neo4j-cypher"],
+      "env": {
+        "NEO4J_URI": "${user_config.neo4j_uri}",
+        "NEO4J_USERNAME": "${user_config.neo4j_username}",
+        "NEO4J_PASSWORD": "${user_config.neo4j_password}",
+        "NEO4J_DATABASE": "${user_config.neo4j_database}",
+        "NEO4J_TRANSPORT": "${user_config.transport}",
+        "NEO4J_NAMESPACE": "${user_config.neo4j_namespace}",
+        "NEO4J_MCP_SERVER_HOST": "${user_config.mcp_server_host}",
+        "NEO4J_MCP_SERVER_PORT": "${user_config.mcp_server_port}"
+      }
+    }
+  },
+  "tools": [
+    {
+      "name": "get_neo4j_schema",
+      "description": "Retrieve the schema of the Neo4j database, including node labels, properties, and relationships"
+    },
+    {
+      "name": "read_neo4j_cypher",
+      "description": "Execute read-only Cypher queries (MATCH, RETURN, etc.) on the Neo4j database"
+    },
+    {
+      "name": "write_neo4j_cypher",
+      "description": "Execute write Cypher queries (CREATE, MERGE, SET, DELETE, etc.) on the Neo4j database"
+    }
+  ],
+  "prompts": [],
+  "tools_generated": false,
+  "license": "MIT",
+  "user_config": {
+    "neo4j_username": {
+      "type": "string",
+      "title": "Neo4j Username",
+      "description": "The username for logging into Neo4j",
+      "default": "neo4j",
+      "required": true,
+      "sensitive": true
+    },
+    "neo4j_password": {
+      "type": "string",
+      "title": "Neo4j Password",
+      "description": "The password for logging into Neo4j",
+      "default": "password",
+      "required": true,
+      "sensitive": true
+    },
+    "neo4j_database": {
+      "type": "string",
+      "title": "Neo4j Database",
+      "description": "The database to use in Neo4j, defaults to neo4j",
+      "default": "neo4j",
+      "required": false,
+      "sensitive": true
+    },
+    "neo4j_uri": {
+      "type": "string",
+      "title": "Neo4j URI",
+      "description": "The URI for connecting to Neo4j",
+      "default": "bolt://localhost:7687",
+      "required": true,
+      "sensitive": true
+    },
+    "neo4j_namespace": {
+      "type": "string",
+      "title": "Namespace",
+      "description": "An optional namespace for the MCP server tools",
+      "default": "",
+      "required": false,
+      "sensitive": false
+    },
+    "transport": {
+      "type": "string",
+      "title": "Transport",
+      "description": "The MCP transport, defaults to stdio",
+      "default": "stdio",
+      "required": false,
+      "sensitive": false
+    },
+    "mcp_server_host": {
+      "type": "string",
+      "title": "MCP Server Host",
+      "description": "The host for the MCP server, if not using stdio. Defaults to 127.0.0.1",
+      "default": "127.0.0.1",
+      "required": false,
+      "sensitive": false
+    },
+    "mcp_server_port": {
+      "type": "number",
+      "title": "MCP Server Port",
+      "description": "The port for the MCP server, if not using stdio. Defaults to 8000",
+      "default": 8000,
+      "required": false,
+      "sensitive": false
+    }
+  }
+}
diff --git a/servers/mcp-neo4j-cypher/src/mcp_neo4j_cypher/server.py b/servers/mcp-neo4j-cypher/src/mcp_neo4j_cypher/server.py
@@ -137,11 +137,14 @@ def clean_schema(schema: dict) -> dict:
                 schema_clean = clean_schema(schema)
                 schema_clean_str = json.dumps(schema_clean)
 
-                return [types.TextContent(type="text", text=schema_clean_str)]
+                return types.CallToolResult(content=[types.TextContent(type="text", text=schema_clean_str)])
 
         except Exception as e:
             logger.error(f"Database error retrieving schema: {e}")
-            return [types.TextContent(type="text", text=f"Error: {e}")]
+            return types.CallToolResult(
+                isError=True, 
+                content=[types.TextContent(type="text", text=f"Error: {e}")]
+            )
 
     async def read_neo4j_cypher(
         query: str = Field(..., description="The Cypher query to execute."),
@@ -151,22 +154,25 @@ async def read_neo4j_cypher(
     ) -> list[types.TextContent]:
         """Execute a read Cypher query on the neo4j database."""
 
-        if _is_write_query(query):
-            raise ValueError("Only MATCH queries are allowed for read-query")
-
         try:
+            if _is_write_query(query):
+                raise ValueError("Only MATCH queries are allowed for read-query")
+        
             async with neo4j_driver.session(database=database) as session:
                 results_json_str = await session.execute_read(_read, query, params)
 
                 logger.debug(f"Read query returned {len(results_json_str)} rows")
 
-                return [types.TextContent(type="text", text=results_json_str)]
+                return types.CallToolResult(content=[types.TextContent(type="text", text=results_json_str)])
 
         except Exception as e:
             logger.error(f"Database error executing query: {e}\n{query}\n{params}")
-            return [
+            return types.CallToolResult(
+                isError=True, 
+                content=[
                 types.TextContent(type="text", text=f"Error: {e}\n{query}\n{params}")
             ]
+            )
 
     async def write_neo4j_cypher(
         query: str = Field(..., description="The Cypher query to execute."),
@@ -176,10 +182,10 @@ async def write_neo4j_cypher(
     ) -> list[types.TextContent]:
         """Execute a write Cypher query on the neo4j database."""
 
-        if not _is_write_query(query):
-            raise ValueError("Only write queries are allowed for write-query")
-
         try:
+            if not _is_write_query(query):
+                raise ValueError("Only write queries are allowed for write-query")
+        
             async with neo4j_driver.session(database=database) as session:
                 raw_results = await session.execute_write(_write, query, params)
                 counters_json_str = json.dumps(
@@ -188,13 +194,16 @@ async def write_neo4j_cypher(
 
             logger.debug(f"Write query affected {counters_json_str}")
 
-            return [types.TextContent(type="text", text=counters_json_str)]
+            return types.CallToolResult(content=[types.TextContent(type="text", text=counters_json_str)])
 
         except Exception as e:
             logger.error(f"Database error executing query: {e}\n{query}\n{params}")
-            return [
+            return types.CallToolResult(
+                isError=True, 
+                content=[
                 types.TextContent(type="text", text=f"Error: {e}\n{query}\n{params}")
             ]
+            )
 
     namespace_prefix = _format_namespace(namespace)
     
diff --git a/servers/mcp-neo4j-cypher/tests/integration/test_server_IT.py b/servers/mcp-neo4j-cypher/tests/integration/test_server_IT.py
@@ -9,7 +9,8 @@
 async def test_get_neo4j_schema(mcp_server: FastMCP, init_data: Any):
     response = await mcp_server.call_tool("get_neo4j_schema", dict())
 
-    schema = json.loads(response[0].text)[0]
+    temp_parsed = json.loads(response[0].text)['content'][0]['text']
+    schema = json.loads(temp_parsed)[0]
 
     # Verify the schema result
     assert "label" in schema
@@ -22,8 +23,7 @@ async def test_write_neo4j_cypher(mcp_server: FastMCP):
     # Execute a Cypher query to create a node
     query = "CREATE (n:Test {name: 'test', age: 123}) RETURN n.name"
     response = await mcp_server.call_tool("write_neo4j_cypher", dict(query=query))
-
-    result = json.loads(response[0].text)
+    result = json.loads(json.loads(response[0].text)['content'][0]['text'])
     # Verify the node creation
     assert len(result) == 4
     assert result["nodes_created"] == 1
@@ -43,7 +43,7 @@ async def test_read_neo4j_cypher(mcp_server: FastMCP, init_data: Any):
     """
 
     response = await mcp_server.call_tool("read_neo4j_cypher", dict(query=query))
-    result = json.loads(response[0].text)
+    result = json.loads(json.loads(response[0].text)['content'][0]['text'])
     # # Verify the query result
     assert len(result) == 2
     assert result[0]["person"] == "Alice"
