-
Notifications
You must be signed in to change notification settings - Fork 2.8k
mcp-agent-for-postgres #3182
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
mcp-agent-for-postgres #3182
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # PostgreSQL MCP Agent | ||
|
|
||
| This agent uses the PostgreSQL MCP server to interact with PostgreSQL databases. It demonstrates how to: | ||
| - Connect to a PostgreSQL database using MCP (Model Context Protocol) | ||
| - Use `uvx` to run the MCP server without manual installation | ||
| - Pass database credentials securely via environment variables | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| * **PostgreSQL Database**: You need access to a PostgreSQL database with a connection string | ||
| * **uvx**: The agent uses `uvx` (part of the `uv` package manager) to run the MCP server | ||
|
|
||
| ## Setup Instructions | ||
|
|
||
| ### 1. Configure Database Connection | ||
|
|
||
| Create a `.env` file in the `mcp_postgres_agent` directory: | ||
|
|
||
| ```bash | ||
| POSTGRES_CONNECTION_STRING=postgresql://user:password@host:port/database | ||
| ``` | ||
|
|
||
| Example connection string format: | ||
| ``` | ||
| postgresql://username:password@localhost:5432/mydb | ||
| postgresql://postgres.xyz:password@aws-region.pooler.supabase.com:5432/postgres | ||
| ``` | ||
|
|
||
| ### 2. Run the Agent | ||
|
|
||
| Start the ADK Web UI from the samples directory: | ||
|
|
||
| ```bash | ||
| adk web | ||
| ``` | ||
|
|
||
| The agent will automatically: | ||
| - Load the connection string from the `.env` file | ||
| - Use `uvx` to run the `postgres-mcp` server with unrestricted access mode | ||
| - Connect to your PostgreSQL database | ||
|
|
||
| ### 3. Example Queries | ||
|
|
||
| Once the agent is running, try these queries: | ||
|
|
||
| * "What tables are in the database?" | ||
| * "Show me the schema for the users table" | ||
| * "Query the first 10 rows from the products table" | ||
| * "What indexes exist on the orders table?" | ||
| * "Create a new table called test_table with columns id and name" | ||
|
|
||
| ## Configuration Details | ||
|
|
||
| The agent uses: | ||
| - **Model**: Gemini 2.0 Flash | ||
| - **MCP Server**: `postgres-mcp` (via `uvx`) | ||
| - **Access Mode**: Unrestricted (allows read/write operations). **Warning**: Using unrestricted mode in a production environment can pose significant security risks. It is recommended to use a more restrictive access mode or configure database user permissions appropriately for production use. | ||
| - **Connection**: StdioConnectionParams with 60-second timeout | ||
| - **Environment Variable**: `DATABASE_URI` (mapped from `POSTGRES_CONNECTION_STRING`) | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| - Ensure your `POSTGRES_CONNECTION_STRING` is correctly formatted | ||
| - Verify database credentials and network access | ||
| - Check that `uv` is installed (`pip install uv` or `brew install uv`) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Copyright 2025 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from . import agent |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Copyright 2025 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import os | ||
|
|
||
| from dotenv import load_dotenv | ||
| from google.adk.agents.llm_agent import LlmAgent | ||
| from google.adk.tools.mcp_tool import StdioConnectionParams | ||
| from google.adk.tools.mcp_tool.mcp_toolset import MCPToolset | ||
| from google.genai.types import GenerateContentConfig | ||
| from mcp import StdioServerParameters | ||
|
|
||
| load_dotenv() | ||
|
|
||
| POSTGRES_CONNECTION_STRING = os.getenv("POSTGRES_CONNECTION_STRING") | ||
| if not POSTGRES_CONNECTION_STRING: | ||
| raise ValueError( | ||
| "POSTGRES_CONNECTION_STRING environment variable not set. " | ||
| "Please create a .env file with this variable." | ||
| ) | ||
|
|
||
| root_agent = LlmAgent( | ||
| model="gemini-2.0-flash", | ||
| name="postgres_agent", | ||
| instruction=( | ||
| "You are a PostgreSQL database assistant. " | ||
| "Use the provided tools to query, manage, and interact with " | ||
| "the PostgreSQL database. Ask clarifying questions when unsure." | ||
| ), | ||
| tools=[ | ||
| MCPToolset( | ||
| connection_params=StdioConnectionParams( | ||
| server_params=StdioServerParameters( | ||
| command="uvx", | ||
| args=["postgres-mcp", "--access-mode=unrestricted"], | ||
| env={"DATABASE_URI": POSTGRES_CONNECTION_STRING}, | ||
| ), | ||
| timeout=60, | ||
| ), | ||
| ) | ||
| ], | ||
| generate_content_config=GenerateContentConfig( | ||
| temperature=0.2, | ||
| top_p=0.95, | ||
| ), | ||
| ) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.