返回 MCP 目录
public公开dns本地运行

postgis-mcp

一个基于TypeScript开发的服务器应用,通过Model Context Protocol (MCP)提供PostGIS数据库连接支持。

article

README

🚀 PostGIS MCP 服务器

PostGIS MCP 服务器是一个使用模型上下文协议(MCP)提供 PostGIS 数据库连接的服务器应用程序,能为开发和生产环境提供稳定的数据库连接服务。

🚀 快速开始

本项目是一个使用模型上下文协议(MCP)提供 PostGIS 数据库连接的服务器应用程序。下面将为你介绍其快速开始的方法。

✨ 主要特性

  • 采用 TypeScript 开发,提供类型安全的开发体验。
  • 集成了模型上下文协议(MCP),便于与其他系统进行交互。
  • 支持 PostGIS 数据库,可处理地理空间数据。
  • 提供开发和生产环境的配置选项,方便不同场景使用。
  • 支持热重载,提高开发效率。

📦 安装指南

环境要求

  • Node.js(v14 或更高版本)
  • 安装了 PostGIS 扩展的 PostgreSQL
  • npm 或 yarn

安装步骤

  1. 克隆项目:
git clone https://github.com/receptopalak/postgis-mcp.git
cd postgis-mcp
  1. 安装依赖:
npm install
  1. 创建 .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

🤝 贡献指南

  1. Fork 此仓库。
  2. 创建你的特性分支 (git checkout -b feature/amazing-feature)。
  3. 提交你的更改 (git commit -m 'feat: Add some amazing feature')。
  4. 将更改推送到该分支 (git push origin feature/amazing-feature)。
  5. 打开一个 Pull Request。

📄 许可证

本项目采用 ISC 许可证。有关更多信息,请参阅 LICENSE 文件。

📧 联系信息

项目所有者 - @receptopalak 项目链接: https://github.com/receptopalak/postgis-mcp

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端