postgres-skills — GitHub Copilot plugin: setup and use
This plugin gives GitHub Copilot PostgreSQL guidance and connects tools for working with a live database.
copilot plugin install postgres-skills@awesome-copilotWhat postgres-skills does
postgres-skills packages a PostgreSQL skill with the postgres-mcp MCP server. Its guidance covers indexes, vector search and RAG, JSONB, partitioning, security, replication, and knowledge graphs, helping the agent choose the relevant database path.
The package includes GitHub Copilot manifests, MCP configuration, and SETUP.md. postgres-mcp runs locally through npx; it can read or write only within the selected PostgreSQL role’s permissions, while CSV tools access explicitly approved local paths.
Database writes, file imports, graph changes, and Azure resource changes require confirmation. Use a dedicated least-privilege PostgreSQL role for exploration, because data returned by the server becomes part of the AI assistant conversation.
What it helps with
- choose indexes for PostgreSQL queries
- design vector search and RAG flows
- query and structure JSONB data
- plan partitioning and replication
- review database role permissions
Example prompts for the agent
- Review this PostgreSQL schema and suggest indexes for its common queries.
- Design a vector search and RAG flow for this database.
- Tell me which permissions this role needs for read-only database exploration.
How to install postgres-skills
Command from the source
copilot plugin install postgres-skills@awesome-copilotStep by step, with commands for each platform: Claude Code plugins: marketplaces, installing, and building your own
Questions about postgres-skills
How do I install postgres-skills in GitHub Copilot?
Run copilot plugin install postgres-skills@awesome-copilot.
What does postgres-skills do?
It adds PostgreSQL guidance and the postgres-mcp MCP server, so GitHub Copilot can work with a connected database using relevant database tools.
What permissions does postgres-skills need?
The server operates with the selected PostgreSQL role’s permissions. A dedicated least-privilege role with read-only access is recommended for exploration.
Source text
plugin · MIT
# postgres-skills plugin The installable plugin payload for the `postgres-skills` marketplace. It bundles the PostgreSQL skill and the `postgres-mcp` MCP server so AI-agent CLIs (GitHub Copilot CLI, Claude Code, Codex) can route PostgreSQL work to the right guidance and tools. ## Contents | Path | Purpose | | --- | --- | | `skills/postgresql-best-practices/` | The skill (SKILL.md routing table + reference docs). | | `plugin.json` | Agent Plugins v1.0 manifest used by GitHub Copilot. | | `mcp.json` | Agent Plugins v1.0 declaration for the `postgres-mcp` server. | | `.mcp.json` | Declares the `postgres-mcp` MCP server (local stdio through `npx`, with optional telemetry disabled). | | `SETUP.md` | Connection, permissions, data-access, privacy, and removal guidance. | | `.claude-plugin/plugin.json` | Plugin identity and display metadata for Claude Code. | | `.codex-plugin/plugin.json` | Plugin manifest required by Codex. | ## Plugin manifests Codex requires a manifest at **`.codex-plugin/plugin.json`** inside the plugin folder. Without it, `codex plugin add postgres-skills@postgres-skills` fails with `Error: missing plugin.json`. Claude Code reads plugin metadata from **`.claude-plugin/plugin.json`**. GitHub Copilot reads the Agent Plugins v1.0 **`plugin.json`** and **`mcp.json`** files at the plugin root. Keep the host manifests and marketplace metadata in `.github/plugin/marketplace.json` at the same release version. ## Security and privacy The plugin launches [`@microsoft/postgres-mcp`](https://github.com/microsoft/postgres-mcp) locally through `npx`. It can read from and write to the database permitted by the selected PostgreSQL role, and its CSV tools can read explicitly approved local paths. Database information returned by the MCP server becomes part of the user's AI-assistant interaction. The bundled configuration disables postgres-mcp telemetry. Use a dedicated, least-privilege role and a read-only profile for exploration. The skills require confirmation before database writes, file imports, graph writes, or Azure resource changes. See [SETUP.md](SETUP.md) for the complete access and data-use disclosure.
© Microsoft · MIT · microsoft/postgres-skills
