article
README
🚀 PostGIS MCP 服务器
PostGIS MCP 服务器是一个使用模型上下文协议(MCP)提供 PostGIS 数据库连接的服务器应用程序,能为开发和生产环境提供稳定的数据库连接服务。
🚀 快速开始
本项目是一个使用模型上下文协议(MCP)提供 PostGIS 数据库连接的服务器应用程序。下面将为你介绍其快速开始的方法。
✨ 主要特性
- 采用 TypeScript 开发,提供类型安全的开发体验。
- 集成了模型上下文协议(MCP),便于与其他系统进行交互。
- 支持 PostGIS 数据库,可处理地理空间数据。
- 提供开发和生产环境的配置选项,方便不同场景使用。
- 支持热重载,提高开发效率。
📦 安装指南
环境要求
- Node.js(v14 或更高版本)
- 安装了 PostGIS 扩展的 PostgreSQL
- npm 或 yarn
安装步骤
- 克隆项目:
git clone https://github.com/receptopalak/postgis-mcp.git
cd postgis-mcp
- 安装依赖:
npm install
- 创建
.env文件:
NODE_ENV=development
DB_PORT=5432
DB_HOST=localhost
DB_NAME=your_database_name
DB_USER=your_username
DB_PASSWORD=your_password
💻 使用示例
开发模式
npm run dev
生产模式
npm run build
npm start
📚 详细文档
MCP 配置
你可以使用以下示例配置来配置 MCP 服务器:
{
"mcpServers": {
"postgis": {
"command": "npx",
"args": ["tsx", "server.ts"],
"env": {
"NODE_ENV": "development",
"DB_PORT": "5432",
"DB_HOST": "host",
"DB_NAME": "dbname",
"DB_USER": "user",
"DB_PASSWORD": "pass"
}
}
}
}
依赖项
- @modelcontextprotocol/sdk: ^1.12.1
- dotenv: ^16.5.0
- pg: ^8.16.0
- zod: ^3.25.64
🤝 贡献指南
- Fork 此仓库。
- 创建你的特性分支 (
git checkout -b feature/amazing-feature)。 - 提交你的更改 (
git commit -m 'feat: Add some amazing feature')。 - 将更改推送到该分支 (
git push origin feature/amazing-feature)。 - 打开一个 Pull Request。
📄 许可证
本项目采用 ISC 许可证。有关更多信息,请参阅 LICENSE 文件。
📧 联系信息
项目所有者 - @receptopalak 项目链接: https://github.com/receptopalak/postgis-mcp
微信扫一扫