使用说明
Netmex MCP
一个轻量级且可扩展的模型上下文协议(MCP)服务器工具包,用于构建与AI助手集成的自定义工具。
此软件包提供了一个即用型MCP服务器、一个用于定义工具的干净结构,以及开发人员在不修改软件包的情况下添加自己的工具的选项。
安装
npm install @netmex/mcp
或者用纱线:
yarn add @netmex/mcp
用法
安装后,您可以使用以下命令运行MCP服务器:
npx netmex-mcp
创建自定义工具
要添加自己的工具,请在项目根目录下的mcp-tools/目录中创建一个工具文件:
示例工具(TypeScript)
import type { Tool } from "@netmex/mcp/types";
const GreetTool: Tool = {
name: "greet",
description: "Returns a friendly greeting",
inputSchema: {
type: "object",
properties: {
name: { type: "string", description: "Name to greet" }
},
required: ["name"]
},
handler: async ({ name }) => ({
content: [
{
type: "text",
text: `Hello, ${name}!`
}
]
})
};
export default GreetTool;
在项目中使用工具
一旦放置在mcp-tools/中,加载器就会自动发现工具并将其暴露给mcp客户端。
无需注册。 没有编辑包代码。 只需将工具文件放置到位。
访问工具输入
每个工具都接收结构化参数,并根据其 inputSchema.
推荐的目录布局
your-project/
├── mcp-tools/
│ ├── GreetTool.ts
│ └── AnotherTool.ts
├── node_modules/
├── package.json
└── ...
NPM插件工具
你也可以从npm安装工具。 名称以以下字符开头的任何依赖项:
netmex-mcp-tool-
将由服务器自动加载。
例子:
npm install netmex-mcp-tool-analytics
处理错误
如果工具抛出或返回无效值,服务器会自动返回JSON-RPC错误:
{
"error": {
"code": -32603,
"message": "Internal error",
"data": { "details": "Something went wrong" }
}
}
在处理程序内使用try/catch进行自定义错误响应。
内置工具
默认情况下,此软件包包括一些工具:
- 关于
- 你好
- (更多内容即将发布)
发展
要在本地构建MCP服务器:
npm install
npm run build
要直接启动它:
npm run start
更多关于MCP
有关模型上下文协议的更多信息,请访问 MCP官方文件.
许可证
该项目根据MIT许可证获得许可。
