GraphRAG TypeScript MCP Tools
Provides tools for querying and analyzing movie data in a Neo4j graph database, including graph statistics, movie search by genre, paginated browsing, and detailed movie retrieval.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@GraphRAG TypeScript MCP Tools Can you show me the highest rated action movies?"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
GraphRAG TypeScript MCP Tools
A complete implementation of a GraphRAG MCP server built with TypeScript, Neo4j, and the MCP TypeScript SDK. This project demonstrates how to build production-quality MCP servers that expose graph-backed tools, resources, and advanced features like LLM sampling and completions.
Built as part of the Neo4j GraphAcademy — Building GraphRAG TypeScript MCP tools course.
What is MCP?
The Model Context Protocol (MCP) is an open standard by Anthropic that allows AI agents (Claude, Cursor, VS Code Copilot) to connect to external tools and data sources in a standardized way.
Related MCP server: CodeRAG
Project Structure
genai-mcp-build-custom-tools-typescript/ ├── server/ │ └── index.ts ← Main MCP server: 4 tools + 1 resource + sampling + completions ├── strawberry/ │ └── index.ts ← First MCP server: simple countLetters tool ├── solutions/ ← Course reference solutions ├── .vscode/ │ └── mcp.json ← VS Code MCP configuration └── README.md
What Was Built
Step 1 — First MCP Server (strawberry/index.ts)
The simplest possible MCP server. One tool, no database, stdio transport.
server.registerTool("countLetters", {
description: "Count occurrences of a letter in the text",
inputSchema: {
text: z.string().describe("The text to search in"),
search: z.string().describe("The letter to count"),
},
}, async ({ text, search }) => ({
content: [{
type: "text",
text: String(text.toLowerCase().split(search.toLowerCase()).length - 1),
}],
}));Test result: countLetters("strawberry", "r") → 3
Tested using the MCP Inspector — a browser-based tool for exploring and testing MCP servers.
Step 2 — Neo4j Connection (Module Scope)
Unlike Python's lifespan context manager, TypeScript uses module-scope variables — the driver is created once at the top of the file and shared by all tools directly.
// Created ONCE when file loads — shared by all tools
const driver: Driver = neo4j.driver(
process.env["NEO4J_URI"] ?? "neo4j://localhost:7687",
neo4j.auth.basic(
process.env["NEO4J_USERNAME"] ?? "neo4j",
process.env["NEO4J_PASSWORD"] ?? "password"
)
);
const database = process.env["NEO4J_DATABASE"] ?? "neo4j";Graceful shutdown via SIGINT:
process.on("SIGINT", async () => {
await driver.close();
await server.close();
process.exit(0);
});Step 3 — Tool 1: graphStatistics
Counts all nodes and relationships in Neo4j.
Result: {"nodes": 28863, "relationships": 332522}
Step 4 — Tool 2: getMoviesByGenre
Searches movies by genre ordered by IMDB rating. Uses console.error() for logging — never console.log() in stdio servers (it corrupts the JSON-RPC channel).
server.registerTool("getMoviesByGenre", {
description: "Get movies by genre from the Neo4j database",
inputSchema: {
genre: z.string().describe("The genre to search for (e.g., Action, Comedy, Drama)"),
limit: z.number().default(10).describe("Maximum number of movies to return"),
},
}, async ({ genre, limit }) => {
const { records } = await driver.executeQuery(query,
{ genre, limit: neo4j.int(limit) }, // neo4j.int() for 64-bit integer compatibility
{ database }
);
...
});Step 5 — Tool 3: browse_movies_by_genre (Paginated)
Cursor-based pagination using Neo4j's SKIP and LIMIT:
const skip = parseInt(cursor, 10) || 0;
// Cypher: SKIP $skip LIMIT $limit
const nextCursor = movies.length === pageSize ? String(skip + pageSize) : null;Returns:
{
"genre": "Action",
"movies": [...],
"nextCursor": "2",
"page": 1,
"pageSize": 2,
"hasMore": true,
"count": 2
}Step 6 — Resource: movie://{tmdbId}
Exposes full movie details by TMDB ID using ResourceTemplate:
server.registerResource(
"movie",
new ResourceTemplate("movie://{tmdbId}", { list: undefined }),
{ description: "Get detailed information about a specific movie", mimeType: "application/json" },
async (uri, { tmdbId }) => {
// uri.href = "movie://603"
// returns: contents array with JSON movie data
}
);Examples: movie://603 (The Matrix), movie://13 (Forrest Gump)
Step 7 — Advanced: Sampling (explainMovieData)
Tools that call the LLM during execution to convert raw Neo4j data into natural language:
const result = await server.server.createMessage({
messages: [{
role: "user",
content: {
type: "text",
text: `Describe '${movieData.title}' (${movieData.released})...`,
},
}],
maxTokens: 200,
});Without sampling: {'title': 'Toy Story', 'released': '1995', 'actors': [...]}
With sampling (VS Code Copilot): "Toy Story — A clever, funny animated adventure about Woody, a jealous cowboy doll who feels displaced when Buzz Lightyear becomes the new favorite..."
Note: Requires setting capability on the low-level server:
server.server["_capabilities"] = { ...server.server["_capabilities"], completions: {} };
Step 8 — Advanced: Completions
Real-time autocomplete suggestions for genre parameters — queries Neo4j as the user types:
import { CompleteRequestSchema } from "@modelcontextprotocol/sdk/types.js";
server.server.setRequestHandler(CompleteRequestSchema, async (request) => {
if (request.params.argument.name === "genre") {
const { records } = await driver.executeQuery(
`MATCH (g:Genre)
WHERE g.name STARTS WITH $prefix
RETURN g.name AS name
ORDER BY name ASC LIMIT 10`,
{ prefix: request.params.argument.value },
{ database }
);
return { completion: { values: records.map(r => r.get("name")) } };
}
return { completion: { values: [] } };
});Key Differences from Python Version
Concept | Python (FastMCP) | TypeScript (McpServer) |
Tool registration |
|
|
Shared state | Lifespan context manager | Module-scope variables |
Driver access |
|
|
Logging |
|
|
Sampling |
|
|
Completions |
|
|
File structure | Separate files per feature | Everything in one |
Number params | Python int type hints |
|
Prompt params |
| Always |
Setup
Prerequisites
Node.js 20+
npm
Neo4j Sandbox — Recommendations dataset from sandbox.neo4j.com
Install
git clone https://github.com/Akakinad/genai-mcp-build-custom-tools-typescript
cd genai-mcp-build-custom-tools-typescript
npm installConfigure credentials
cat > server/.env << EOF
NEO4J_URI=bolt://your-sandbox-ip:7687
NEO4J_USERNAME=neo4j
NEO4J_PASSWORD=your-password
NEO4J_DATABASE=neo4j
EOFVerify setup
npx tsx client/test_environment.ts
# Expected: All checks passed!Running
Test with MCP Inspector (browser UI)
cd server
npx @modelcontextprotocol/inspector npx tsx index.tsOpen the URL shown in terminal → Connect → Tools tab → List Tools → select a tool → Run Tool.
Run server for AI editor use
cd server
npx tsx index.tsVS Code Configuration (.vscode/mcp.json)
{
"servers": {
"movies-ts": {
"type": "stdio",
"command": "npx",
"args": ["tsx", "/absolute/path/to/server/index.ts"]
}
}
}Test in VS Code Copilot
Explain the movie "Toy Story" using the movies-ts MCP tool Search for Action movies using the movies-ts MCP tool Get graph statistics using the movies-ts MCP tool
Course
Learning Path: Generative AI & GraphRAG
Course: Building GraphRAG TypeScript MCP tools
Building GraphRAG TypeScript MCP Tools
Companion repository for the GraphAcademy course Building GraphRAG TypeScript MCP Tools.
Students build an MCP (Model Context Protocol) server that connects to a Neo4j graph database, exposing tools and resources for use with AI assistants.
Getting Started
Copy
.env.exampleto.envand update the values with your Neo4j connection details.Install dependencies:
npm installStart the server:
npm startInspect the server with the MCP Inspector:
npm run inspectSolutions
The solutions/ directory contains the completed code for each lesson checkpoint.
Available Tools
4 toolsbrowse_movies_by_genreC
Browse movies in a genre with pagination support
Inputs: genre (required), cursor, pageSize.
explainMovieDataA
Get a natural language explanation of movie data using LLM sampling
Inputs: movieTitle (required).
getMoviesByGenreC
Get movies by genre from the Neo4j database
Inputs: genre (required), limit.
graphStatisticsB
Count the number of nodes and relationships in the graph
Inputs: no named parameters.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 4 tools
The two tools for movies by genre (getMoviesByGenre and browse_movies_by_genre) have overlapping purposes; the only distinction is pagination support, which may cause an agent to misselect. Other tools are distinct.
Mixes camelCase (getMoviesByGenre, explainMovieData, graphStatistics) and snake_case (browse_movies_by_genre) with different verb conventions ('get' vs 'browse'), showing inconsistency.
With only 4 tools, the surface is minimal but perhaps appropriate for a read-only movie graph query server. It borders on being too few but is not extreme.
Missing basic operations like fetching a specific movie by ID, listing all genres, or querying actors/relationships. The tool set covers only a small subset of expected graph queries, leaving significant gaps.
Maintenance
Related MCP Connectors
MCP server unifying ERPs, CRMs, APIs and knowledge base for Claude, ChatGPT and Gemini.
MCP server for AI dialogue using various LLM models via AceDataCloud
MCP server that lets your AI assistant build and deploy apps, hosting each one at a live URL.
One MCP server for the services your AI needs: memory, files, Microsoft 365, kanban and more.
Related MCP Servers
- FlicenseNot gradedqualityDmaintenanceAn MCP server that enables graph database interactions with Neo4j, allowing users to access and manipulate graph data through natural language commands.-
- AlicenseNot gradedqualityDmaintenanceAn MCP server that transforms codebases into knowledge graphs using Neo4J, enabling AI assistants to understand code structure, relationships, and metrics for more context-aware assistance.28MIT
- AlicenseAqualityDmaintenanceAn MCP server that enables LLMs to perform semantic and fulltext searches within Neo4j while executing complex, search-augmented Cypher queries for GraphRAG applications. It provides tools for database schema discovery and supports multi-provider embeddings to facilitate advanced graph traversals.53MIT
- AlicenseNot gradedqualityBmaintenanceMCP server for Neo4j graph database operations, enabling Cypher queries, node/relationship management, and schema discovery.1BSD 3-Clause