dokploy-mcp AGENTS.md

AGENTS.md

Welcome to the Smithery TypeScript MCP Server Scaffold!

This is the template project that gets cloned when you run npx create-smithery. It provides everything you need to build, test, and deploy a Model Context Protocol (MCP) server with Smithery.

What's Included

• TypeScript MCP Server with Zod-based configuration schema support
• Example Tool (hello tool with debug mode configuration)
• Example Resource (history://hello-world with Hello World origin story)
• Example Prompt (greet prompt for generating greeting messages)
• Development Workflow (npm run dev for local testing with hot reload)
• Deployment Ready configuration for the Smithery platform
• Session Management via createStatefulServer or createStatelessServer with optional config schemas

Quick Start Commands

# Run development server (streamable HTTP on port 3000)
npm run dev

# Build for production
npm run build

Development Workflow

Based on the Model Context Protocol architecture, MCP servers provide three core primitives:

1. Tools (for actions)

Add executable functions that AI applications can invoke to perform actions:

// Add a tool
server.registerTool(
  "hello",
  {
    title: "Hello Tool",
    description: "Say hello to someone",
    inputSchema: { name: z.string().describe("Name to greet") },
  },
  async ({ name }) => {
    // Access session config if using stateful server
    const greeting = config.debug 
      ? `DEBUG: Hello, ${name}!`
      : `Hello, ${name}!`
    
    return {
      content: [{ type: "text", text: greeting }],
    }
  },
)

2. Resources (for static data)

Add data sources that provide contextual information:

// Add a resource
server.registerResource(
  "hello-world-history",
  "history://hello-world",
  {
    title: "Hello World History",
    description: "The origin story of the famous 'Hello, World' program",
  },
  async uri => ({
    contents: [
      {
        uri: uri.href,
        text: '"Hello, World" first appeared in a 1972 Bell Labs memo by Brian Kernighan and later became the iconic first program for beginners in countless languages.',
        mimeType: "text/plain",
      },
    ],
  }),
)