DynamoDB-Toolbox

Version: v2

On this page

MCPToolkit

note

MCPToolkit requires the zod and @modelcontextprotocol/sdk dependencies to be installed first:

npm install zod @modelcontextprotocol/sdk

A utility for quickly adding Tools to an MCP Server, enabling any MCP Clients (like Claude or Cursor) to interact with your DynamoDB Tables using natural language.

import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'
import { MCPToolkit } from 'dynamodb-toolbox/database/actions/mcpToolkit'

// Set up your MCP Server as usual
const server = new McpServer(...)

const mcpToolkit = PokeDB.build(MCPToolkit)
mcpToolkit.addTools(server)

info

We highly recommend adding title and description metadata to your models for better LLM processing. For more details, see:

• For Tables: The meta property
• For Entities: The meta property
• For Table Access Patterns: The meta method
• For Entity Access Patterns: The meta method

Methods​

addTools(...)​

(server:McpServer, options?: Options) => MCPToolkit

Adds DynamoDB-Toolbox querying tools to an MCP Server. See Available Tools for a list of supported operations.

Examples

• Usage
• Read-only

mcpToolkit.addTools(server)

Available tools​

The following tools are available:

Access Pattern Tools​

ddb-tb_use-<KEY>-access-pattern-on-<TABLE>-table​

Enables querying items from the database using a registered AccessPattern.

Entity Tools​

ddb-tb_get-${entityName}-item-from-${dbTableKey}-table​

Enables retrieving an entity item from the database.

ddb-tb_put-${entityName}-item-in-${dbTableKey}-table​

(Unavailable in readonly mode)

Enables inserting an entity item in the database.

ddb-tb_delete-${entityName}-item-from-${dbTableKey}-table​

Enables deleting an entity item from the database.

info

All tools automatically apply validation, default values, links, encoding/decoding and formatting.

• Methods
  • addTools(...)
• Available tools
  • Access Pattern Tools
  • Entity Tools