使用说明
MCP连接器
MCP连接器 是一个轻量级服务器,可以运行和管理多个模型上下文协议(MCP)服务器,专门设计用于与 打字思维。它提供了一种在本地计算机或远程服务器上运行MCP服务器的简单方法,使您可以通过简单的REST API将自定义AI模型或工具与TypingMind连接起来。
如何在本地设备上运行
您可以使用以下命令快速启动MCP连接器 npx (无需安装):
npx @typingmind/mcp@latest <auth-token>
- 替换
<auth-token>您的身份验证令牌由TypingMind提供。
您还可以通过环境变量提供身份验证令牌:
MCP_AUTH_TOKEN=<auth-token> npx @typingmind/mcp@latest
使用TypingMind时,保持流程运行。
HTTPS支持
要启用HTTPS,请设置以下环境变量:
CERTFILE=./path/to/certificate.crt KEYFILE=./path/to/privatekey.key npx @typingmind/mcp@latest <auth-token>
CERTFILE:SSL证书文件的路径KEYFILE:SSL私钥文件的路径
当两个变量都设置时,服务器将使用HTTPS而不是HTTP。
如何在服务器上运行
如果您更喜欢在远程服务器上运行MCP连接器:
-
安装Node.js (版本14或更高版本)。
-
使用以下命令运行服务器
npx:npx @typingmind/mcp@latest <auth-token>要使用HTTPS运行:
CERTFILE=./path/to/certificate.crt KEYFILE=./path/to/privatekey.key npx @typingmind/mcp@latest <auth-token>或者,对于持久运行(例如,在关闭SSH后),您可以使用以下流程管理器 pm2 或
screen/tmux:pm2 start npx -- @typingmind/mcp@latest <auth-token>
如何使用Docker运行
您还可以使用Docker运行MCP连接器。
-
构建Docker镜像: 导航到项目的根目录(其中
Dockerfile位于)并运行:docker build -t mcp-connector .(您可以替换
mcp-connector使用您喜欢的图像标签。) -
运行Docker容器:
-
基本运行(HTTP): 替换
<auth-token>用你真正的代币。此命令以分离模式运行容器(-d)并映射容器的默认端口50880连接到主机上的同一端口。docker run -d -p 50880:50880 --name mcp-connector-instance mcp-connector <auth-token> -
使用其他端口: 如果需要使用其他端口(例如,主机上的8080映射到容器中的12345),请使用
-p映射标志和-e PORT环境变量:docker run -d -p 8080:12345 -e PORT=12345 --name mcp-connector-instance mcp-connector <auth-token> -
使用HTTPS运行: 要启用HTTPS,您需要提供证书和密钥文件,并设置
CERTFILE和KEYFILE环境变量。将主机的证书文件装入容器中(例如,装入/certs目录),并通过环境变量提供路径。记得绘制相应的港口地图。docker run -d \ -p 50880:50880 \ -e PORT=50880 \ -e CERTFILE=/certs/certificate.crt \ -e KEYFILE=/certs/privatekey.key \ -v /path/to/your/certificate.crt:/certs/certificate.crt:ro \ -v /path/to/your/privatekey.key:/certs/privatekey.key:ro \ --name mcp-connector-instance \ mcp-connector <auth-token>(替换
/path/to/your/certificate.crt和/path/to/your/privatekey.key使用主机上的实际路径。这:roflag将它们挂载为只读。) -
查看日志: 要查看正在运行的容器中的日志,请执行以下操作:
docker logs mcp-connector-instance -
停止容器:
docker stop mcp-connector-instance -
移除容器:
docker rm mcp-connector-instance
-
如何连接到TypingMind
要将MCP连接器连接到TypingMind:
- 请遵循以下说明 www.typingmind.com/mcp.
- 粘贴您的MCP连接器服务器地址(
http://localhost:<port>或您服务器的IP地址和端口)以及您在TypingMind MCP集成页面上的身份验证令牌。
REST API端点
所有API端点都需要通过启动服务器时提供的Bearer令牌进行身份验证。
| 端点 | 方法 | 描述 |
|---|---|---|
/ping |
GET | 健康检查;回报 { status: "ok" } |
/start |
POST | 启动一个或多个MCP客户端;主体: { mcpServers: { ... } } |
/restart/:id |
POST | 重新启动特定客户端 |
/clients |
GET | 列出所有正在运行的MCP客户端及其工具 |
/clients/:id |
GET | 获取特定客户端的信息 |
/clients/:id/tools |
GET | 列出客户端可用的工具 |
/clients/:id/call_tools |
POST | 为客户端调用工具;主体: { name, arguments } |
/clients/:id |
DELETE | 停止并删除客户端 |
笔记:
- 所有请求都需要
Authorization: Bearer <auth-token>头球 - 可用端口:服务器将选择端口
50880或50881,确保 这些端口在您的系统中可用。您还可以使用PORT环境 变量以指定其他端口。
许可证
麻省理工学院