Merge pull request #101 from neo4j-contrib/cypher-improve-tool-annotations

update fastmcp version, add annotations, update changelog

Author: a-s-g93

servers/mcp-neo4j-cypher/CHANGELOG.md

@@ -12,6 +12,7 @@
 * Add error indicator to tool results in the `CallToolResult` object
 * Add HTTP transport option
 * Migrate to FastMCP v2.x
+* Add tool annotations
 * Update Dockerfile for http configuration
 
 ## v0.2.4

servers/mcp-neo4j-cypher/pyproject.toml

@@ -5,7 +5,7 @@ description = "A simple Neo4j MCP server"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-    "fastmcp>=2.0.0",
+    "fastmcp>=2.2.7",
     "neo4j>=5.26.0",
     "pydantic>=2.10.1",
 ]

servers/mcp-neo4j-cypher/src/mcp_neo4j_cypher/server.py

@@ -6,6 +6,7 @@
 from fastmcp.exceptions import ToolError
 from fastmcp.tools.tool import ToolResult, TextContent
 from fastmcp.server import FastMCP
+from mcp.types import ToolAnnotations
 from neo4j import (
     AsyncDriver,
     AsyncGraphDatabase,
@@ -51,7 +52,14 @@ def create_mcp_server(neo4j_driver: AsyncDriver, database: str = "neo4j", namesp
 
     namespace_prefix = _format_namespace(namespace)
 
-    @mcp.tool(name=namespace_prefix+"get_neo4j_schema")
+    @mcp.tool(name=namespace_prefix+"get_neo4j_schema", 
+              annotations=ToolAnnotations(title="Get Neo4j Schema", 
+                                          readOnlyHint=True,
+                                          destructiveHint=False,
+                                          idempotentHint=True,
+                                          openWorldHint=True
+                                          )
+            )
     async def get_neo4j_schema() -> list[ToolResult]:
         """List all node, their attributes and their relationships to other nodes in the neo4j database.
         If this fails with a message that includes "Neo.ClientError.Procedure.ProcedureNotFound"
@@ -143,7 +151,13 @@ def clean_schema(schema: dict) -> dict:
             logger.error(f"Database error retrieving schema: {e}")
             raise ToolError(f"Error: {e}")
 
-    @mcp.tool(name=namespace_prefix+"read_neo4j_cypher")
+    @mcp.tool(name=namespace_prefix+"read_neo4j_cypher", 
+              annotations=ToolAnnotations(title="Read Neo4j Cypher", 
+                                          readOnlyHint=True,
+                                          destructiveHint=False,
+                                          idempotentHint=True,
+                                          openWorldHint=True
+                                          ))
     async def read_neo4j_cypher(
         query: str = Field(..., description="The Cypher query to execute."),
         params: Optional[dict[str, Any]] = Field(
@@ -167,7 +181,13 @@ async def read_neo4j_cypher(
             logger.error(f"Database error executing query: {e}\n{query}\n{params}")
             raise ToolError(f"Error: {e}\n{query}\n{params}")
 
-    @mcp.tool(name=namespace_prefix+"write_neo4j_cypher")
+    @mcp.tool(name=namespace_prefix+"write_neo4j_cypher", 
+              annotations=ToolAnnotations(title="Write Neo4j Cypher", 
+                                          readOnlyHint=False,
+                                          destructiveHint=True,
+                                          idempotentHint=False,
+                                          openWorldHint=True
+                                          ))
     async def write_neo4j_cypher(
         query: str = Field(..., description="The Cypher query to execute."),
         params: Optional[dict[str, Any]] = Field(