sample-mcp

sample-mcp

A sample MCP server built with Node.js and TypeScript, demonstrating the three core primitives: Tools, Resources, and Prompts.

Category
访问服务器

README

Sample MCP Server

A sample MCP (Model Context Protocol) server built with Node.js and TypeScript, demonstrating the three core primitives: Tools, Resources, and Prompts.

What is MCP?

Model Context Protocol (MCP) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs). Think of it as a "USB-C port for AI" - a universal connector that allows AI assistants to interact with various data sources and tools in a consistent way.

MCP enables:

  • AI models to access external data and services
  • Developers to build integrations that work across multiple AI platforms
  • Secure, controlled interactions between AI and external systems

MCP Core Primitives

MCP defines three fundamental primitives:

1. Tools

Tools are functions that the AI can execute to perform actions or computations. They allow the model to interact with external systems, run calculations, or trigger workflows.

Characteristics:

  • Invoked by the AI model
  • Can have input parameters with validation
  • Return results back to the model
  • Used for actions like: API calls, calculations, file operations, database queries

Example from this project:

// Tool: greet - Greets a user by name
server.registerTool(
  'greet',
  {
    description: 'Greets a user by name',
    inputSchema: {
      name: z.string().describe('The name of the person to greet'),
    },
  },
  async ({ name }) => {
    return {
      content: [{ type: 'text', text: `Hello, ${name}! Welcome to the MCP server.` }],
    }
  },
)

// Tool: add - Adds two numbers together
server.registerTool(
  'add',
  {
    description: 'Adds two numbers together',
    inputSchema: {
      a: z.number().describe('First number'),
      b: z.number().describe('Second number'),
    },
  },
  async ({ a, b }) => {
    return {
      content: [{ type: 'text', text: `The sum of ${a} and ${b} is ${a + b}` }],
    }
  },
)

2. Resources

Resources represent data that the AI can read and use as context. They provide a way to expose information from various sources (files, databases, APIs) to the model.

Characteristics:

  • Read-only data access
  • Can be static (fixed URI) or dynamic (URI templates)
  • Support various MIME types (JSON, text, images, etc.)
  • Used for: configuration data, user profiles, documents, database records

Example from this project:

// Static Resource: Application configuration
server.registerResource(
  'config',
  'config://app',
  {
    description: 'Application configuration',
    mimeType: 'application/json',
  },
  async () => {
    return {
      contents: [{
        uri: 'config://app',
        mimeType: 'application/json',
        text: JSON.stringify({
          appName: 'Sample MCP',
          version: '1.0.0',
          features: ['tools', 'resources', 'prompts'],
        }, null, 2),
      }],
    }
  },
)

// Dynamic Resource: User profile with URI template
server.registerResource(
  'user-profile',
  'users://{userId}/profile',
  {
    description: 'User profile by ID',
    mimeType: 'application/json',
  },
  async (uri, extra) => {
    const { userId } = extra as unknown as { userId: string }
    // Fetch user data based on userId...
    return {
      contents: [{
        uri: uri.href,
        mimeType: 'application/json',
        text: JSON.stringify(userData, null, 2),
      }],
    }
  },
)

3. Prompts

Prompts are reusable prompt templates that help standardize interactions with the AI. They can include predefined instructions, context, and optional arguments for customization.

Characteristics:

  • Pre-defined message templates
  • Can accept arguments for customization
  • Help ensure consistent AI interactions
  • Used for: code review templates, analysis prompts, standardized queries

Example from this project:

// Simple Prompt: No arguments required
server.registerPrompt(
  'explain-code',
  {
    description: 'Prompt for explaining code',
  },
  async () => {
    return {
      messages: [{
        role: 'user',
        content: {
          type: 'text',
          text: 'Please explain the following code in detail, including its purpose, how it works, and any potential improvements.',
        },
      }],
    }
  },
)

// Parameterized Prompt: Accepts arguments for customization
server.registerPrompt(
  'review-code',
  {
    description: 'Prompt for code review with specified focus',
    argsSchema: {
      language: z.string().describe('Programming language of the code'),
      focus: z.string().optional().describe('Focus area: security, performance, readability'),
    },
  },
  async ({ language, focus }) => {
    const focusArea = focus || 'general best practices'
    return {
      messages: [{
        role: 'user',
        content: {
          type: 'text',
          text: `Please review the following ${language} code with a focus on ${focusArea}. Provide specific suggestions for improvement.`,
        },
      }],
    }
  },
)

Comparison Table

Primitive Purpose Direction Use Case
Tools Execute actions AI → Server Calculations, API calls, data mutations
Resources Provide data Server → AI Configuration, documents, user data
Prompts Template messages Server → AI Standardized instructions, reusable queries

Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/your-username/sample-mcp.git
cd sample-mcp

# Install dependencies
npm install

# Build the project
npm run build

Running the Server

# Start the MCP server
npm start

# Or run in development mode with auto-rebuild
npm run dev

Integration with AI Clients

To use this MCP server with an AI client (like Claude Desktop), add it to your MCP configuration:

{
  "mcpServers": {
    "sample-mcp": {
      "command": "node",
      "args": ["/path/to/sample-mcp/dist/main.js"]
    }
  }
}

Project Structure

sample-mcp/
├── src/
│   ├── main.ts       # Main entry point and server setup
│   ├── tools.ts      # Tool definitions (greet, add)
│   ├── resources.ts  # Resource definitions (config, user-profile)
│   └── prompts.ts    # Prompt definitions (explain-code, review-code)
├── dist/             # Compiled JavaScript output
├── package.json      # Project dependencies and scripts
├── tsconfig.json     # TypeScript configuration
└── README.md         # This file

Dependencies

  • @modelcontextprotocol/sdk: Official MCP SDK for building servers
  • zod: TypeScript-first schema validation for input validation

Learn More

License

ISC

推荐服务器

Baidu Map

Baidu Map

百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。

官方
精选
JavaScript
Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。

官方
精选
本地
TypeScript
VeyraX

VeyraX

一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。

官方
精选
本地
graphlit-mcp-server

graphlit-mcp-server

模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。

官方
精选
TypeScript
Kagi MCP Server

Kagi MCP Server

一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。

官方
精选
Python
e2b-mcp-server

e2b-mcp-server

使用 MCP 通过 e2b 运行代码。

官方
精选
Neon MCP Server

Neon MCP Server

用于与 Neon 管理 API 和数据库交互的 MCP 服务器

官方
精选
Exa MCP Server

Exa MCP Server

模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。

官方
精选