jq-simple-mcp-server
v1.0.0
Published
A simple MCP server with stdio transport
Readme
Simple MCP Server
一个使用 TypeScript 编写的最简单的 MCP (Model Context Protocol) 服务器,支持 stdio 协议传输。
功能特性
- 🚀 基于
@modelcontextprotocol/sdk构建 - 📡 支持 stdio 传输协议
- 🛠️ 提供简单的
hello工具演示 - 📦 支持 npx 直接运行
- 💾 完整的 TypeScript 支持
快速开始
安装依赖
npm install编译项目
npm run build运行服务器
# 方式 1: 使用 npm
npm start
# 方式 2: 使用 npx
npx simple-mcp-server
# 方式 3: 开发模式
npm run dev项目结构
simple-mcp-server/
├── src/
│ └── index.ts # 主要服务器逻辑
├── dist/ # 编译输出目录
├── package.json # 项目配置
├── tsconfig.json # TypeScript 配置
└── README.md # 说明文档工具说明
hello 工具
这是一个简单的问候工具,用于演示 MCP 服务器的基本功能。
参数:
name(string, 可选): 要问候的名字,默认为 "World"
示例:
{
"name": "hello",
"arguments": {
"name": "Alice"
}
}响应:
{
"content": [
{
"type": "text",
"text": "Hello, Alice!"
}
]
}开发
脚本命令
npm run build- 编译 TypeScript 代码npm run start- 运行编译后的服务器npm run dev- 开发模式运行(使用 ts-node)
添加新工具
- 在
ListToolsRequestSchema处理器中添加工具定义 - 在
CallToolRequestSchema处理器中添加工具实现
示例:
// 添加工具定义
{
name: "my-tool",
description: "我的工具描述",
inputSchema: {
type: "object",
properties: {
param: {
type: "string",
description: "参数描述",
},
},
},
}
// 添加工具实现
case "my-tool": {
const param = request.params.arguments?.param;
return {
content: [
{
type: "text",
text: `处理结果: ${param}`,
},
],
};
}发布
准备发布
npm run build发布到 npm
npm publish发布后,用户可以通过以下方式使用:
npx simple-mcp-server环境要求
- Node.js >= 18
- npm >= 8
许可证
MIT License
