Merge pull request #6 from modelcontextprotocol/mahesh/update-postgres

Add README to Postgres server

README.md

@@ -18,4 +18,4 @@ mcp-server-postgres
 # ...
 ```
 
-Each server will operate differently. See the READMEs within [src](src/) for more information.
+Each server will operate differently. See the READMEs within [src](src/) for more information.

src/postgres/README.md

@@ -1,3 +1,34 @@
-# PostgreSQL server
+# PostgreSQL
 
-This MCP server provides **resources** and **tools** for interacting with a Postgres database.
+A Model Context Protocol server that provides read-only access to PostgreSQL databases. This server enables LLMs to inspect database schemas and execute read-only queries.
+
+## Components
+
+### Tools
+
+- **query**
+  - Execute read-only SQL queries against the connected database
+  - Input: `sql` (string): The SQL query to execute
+  - All queries are executed within a READ ONLY transaction
+
+### Resources
+
+The server provides schema information for each table in the database:
+
+- **Table Schemas** (`postgres://<host>/<table>/schema`)
+  - JSON schema information for each table
+  - Includes column names and data types
+  - Automatically discovered from database metadata
+
+## Example Usage with the Desktop App
+
+To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your `claude_desktop_config.json`:
+
+```json
+"postgres": {
+  "command": "mcp-server-postgres",
+  "args": ["postgresql://localhost/mydb"]
+}
+```
+
+Replace `/mydb` with your database name.

src/postgres/package.json

@@ -19,7 +19,7 @@
     "watch": "tsc --watch"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "0.5.0",
+    "@modelcontextprotocol/sdk": "0.6.2",
     "pg": "^8.13.0"
   },
   "devDependencies": {