MCP协议服务器

一个基于TypeScript实现的完整Model Context Protocol (MCP)服务器,提供与大型语言模型集成的资源、工具和提示模板。

  • by YanViniciusSilva
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 yanviniciussilva/mcp-server-typescript

使用说明

🚀 TypeScript MCP 服务器

一个完整的服务器 模型上下文协议(MCP) 在TypeScript中实现,提供与LLM集成的功能,工具和提示。

📋 关于项目

本项目演示了如何创建可与 Claude Desktop 等客户端集成的功能 MCP 服务器,提供:

  • 回顾文档、设置和指南
  • 工具:气候领事Calculadora时间戳
  • 提示用于代码分析、文档和故障排除的模板

🛠️ 安装

# Clone o repositório
git clone https://github.com/seu-usuario/mcp-server.git
cd mcp-server

# Instale as dependências
npm install

# Compile o projeto
npm run build

⚙️ 配置

  1. Opcional:复制 env.example 段落 .env 并设置变量:

    cp env.example .env
    
  2. 可用变量:

    • SERVER_NAME服务器名称(默认:“mcp-server-example”)
    • SERVER_VERSION服务器版本(默认:“1.0.0”)

🚀 谎言

可用的命令

# Desenvolvimento (compila + executa)
npm run dev

# Compilar apenas
npm run build

# Executar servidor
npm start

# Ver demonstração das funcionalidades
npm run demo

使用 MCP Inspector 进行测试

# Instalar e executar MCP Inspector
npx @modelcontextprotocol/inspector node build/server.js

这将打开一个Web界面,您可以在其中测试服务器的所有功能。

📁 项目结构

mcp-server/
├── src/
│   ├── server.ts              # Servidor principal
│   ├── types/
│   │   └── index.ts           # Definições de tipos
│   ├── handlers/
│   │   ├── resources.ts       # Manipulador de recursos
│   │   ├── tools.ts          # Manipulador de ferramentas
│   │   └── prompts.ts        # Manipulador de prompts
│   └── example-usage.ts       # Exemplos de uso
├── tests/                     # Arquivos de teste
├── build/                     # JavaScript compilado
├── package.json              # Configuração do projeto
├── tsconfig.json             # Configuração TypeScript
└── README.md                 # Este arquivo

🎯 功能

📋 资源(Recurs)

  • mcp://exemplo/doc1API 文档
  • mcp://exemplo/config1服务器设置
  • mcp://exemplo/help1: 帮助指南

🔧 工具(Tools)

  • 计算器基本数学运算
  • 天气模拟天气信息
  • 时间戳当前日期和时间

💬 提示

  • 分析代码代码分析和审查
  • 生成文档: 文档生成
  • 解决-问题帮助编程问题

🧪 测试

运行可用的测试 :

# Teste direto do servidor
node tests/test-direct.js

# Demonstração das funcionalidades
node demo.js

🔧 开发

添加新功能

  1. 新建资源:编辑 src/handlers/resources.ts
  2. 新建工具:编辑 src/handlers/tools.ts
  3. Novo提示:编辑 src/handlers/prompts.ts
  4. 新类型设置为 src/types/index.ts

编译

npm run build

O código TypeScript汇编 build/.

📚 文档

🤝 贡献

  1. 创建项目分叉
  2. 为您的功能创建一个分支 (git checkout -b feature/nova-funcionalidade)
  3. 提交您的更改(git commit -am 'Adiciona nova funcionalidade')
  4. 推动一个分支(git push origin feature/nova-funcionalidade)
  5. 打开 Pull Request

📄 许可证

这个项目是根据ISC许可证。查看文件 许可证 了解更多详情。

✨ 集成示例

要与 Claude Desktop 一起使用,请在配置文件中添加:

{
  "mcpServers": {
    "mcp-server-exemplo": {
      "command": "node",
      "args": ["/caminho/para/mcp-server/build/server.js"]
    }
  }
}