article
README
🚀 MCP 服务器文档
本项目文档详细介绍了用于与模型上下文协议(Model Context Protocol)配合使用的 MCP 服务器,旨在帮助用户了解其功能、使用方法、设置步骤等重要信息。
🚀 快速开始
MCP 服务器提供了与不同工具交互的功能,下面为你介绍可用的 MCP 服务器及其使用示例。
✨ 主要特性
支持多种服务器类型
- PostgreSQL 服务器:可通过模型上下文协议连接到多个 PostgreSQL 数据库实例。
- Obsidian 服务器:用于与 Obsidian 笔记程序交互。
- n8n 服务器:用于与 n8n 流程自动化工具交互。
提供丰富的工具
每个服务器都配备了相应的工具,以满足不同的使用场景。
📦 安装指南
PostgreSQL 服务器设置
- 进入 PostgreSQL MCP 目录:
cd postgresql-mcp - 安装依赖项并构建:
npm install npm run build - 构建完成的文件位于
build/index.js。
Obsidian 服务器设置
-
在 Obsidian 中安装 Local REST API 插件:
- 打开 Obsidian 设置 → 社区插件。
- 浏览并安装 "Local REST API" 插件。
- 启用插件并复制 API 密钥。
-
进入 Obsidian MCP 目录:
cd obsidian-mcp -
以开发模式安装包:
pip install -e . -
在
.env文件或 MCP 配置中设置 API 密钥。
n8n 服务器设置
-
设置 n8n 实例并创建 API 密钥:
- 登录到 n8n 实例。
- 进入 Settings → API,创建新的 API 密钥并复制。
-
进入 n8n MCP 目录:
cd n8n-mcp -
安装依赖项并构建:
npm install npm run build -
在
.env文件或 MCP 配置中设置 n8n URL 和 API 密钥。
💻 使用示例
PostgreSQL 服务器
基础用法
# 从默认数据库的 users 表中查询所有数据
curl -X GET "http://localhost:3000/api/db1/sql?query=SELECT%20*%20FROM%20users"
Obsidian 服务器
基础用法
# 写入一条新笔记
curl -X POST "http://localhost:3001/api/write" -H "Content-Type: application/json" -d '{"title":"新的笔记","content":"这是我的第一条笔记。"}'
n8n 服务器
基础用法
# 触发预定义的流程
curl -X POST "http://localhost:3002/api/trigger?flowId=123"
📚 详细文档
配置文件示例
编辑 Cursor AI 的 MCP 配置文件 ~/.cursor/mcp.json:
{
"mcpServers": {
"postgresql-mcp": {
"command": "node",
"args": ["/path/to/mcp-servers/postgresql-mcp/build/index.js"],
"env": {
"PG_DB_MAP": "{\"db1\":\"postgresql://username:password@hostname:5432/database_name?sslmode=require\",\"analytics\":\"postgresql://analytics_user:secure_password@analytics-db.example.com:5432/analytics?sslmode=require\",\"default\":\"db1\"}"
}
},
"obsidian-mcp": {
"command": "python",
"args": ["-m", "obsidian_mcp.server"],
"env": {
"OBSIDIAN_API_KEY": "your_api_key"
}
},
"n8n-mcp": {
"command": "node",
"args": ["/path/to/n8n_mcp/build/index.js"],
"env": {
"N8N_URL": "http://localhost:5678",
"N8N_API_KEY": "your_api_key"
}
}
}
}
调试说明
日志文件
- PostgreSQL MCP:日志文件位于
build/logs/postgres.log。 - Obsidian MCP:日志文件位于
obsidian_mcp/log/server.log。 - n8n MCP:日志文件位于
n8n_mcp/build/n8n.log。
使用 MCP Inspector
- 检查 PostgreSQL 服务器:
node inspector.js http://localhost:3000 - 检查 Obsidian 服务器:
python -m obsidian_mcp.inspector - 检查 n8n 服务器:
node inspector.js http://localhost:3002
🔧 技术细节
服务器与协议交互
MCP 服务器通过模型上下文协议与不同的工具进行交互,实现数据的传输和处理。
环境变量的使用
在配置文件和设置过程中,使用环境变量来传递敏感信息,如数据库凭据和 API 密钥,以提高安全性。
📄 许可证
文档中未提及相关许可证信息。
⚠️ 重要提示
- 凭据保护:请确保所有数据库凭据和 API 密钥仅通过环境变量传递,避免硬编码在代码中。
- 网络隔离:建议将 MCP 服务器部署在受信任的网络环境中,限制外部访问。
- 定期更新:及时更新服务器软件以防范已知安全漏洞。
微信扫一扫