Skip to content

Commit 5351447

Browse files
mukul975mukul975
committed
Add project configuration files and documentation
1 parent 8c72f36 commit 5351447

File tree

7 files changed

+657
-1
lines changed

7 files changed

+657
-1
lines changed

‎.gitattributes

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto
3+
4+
# Source code files
5+
*.py text eol=lf
6+
*.json text eol=lf
7+
*.yml text eol=lf
8+
*.yaml text eol=lf
9+
*.toml text eol=lf
10+
*.cfg text eol=lf
11+
*.ini text eol=lf
12+
*.conf text eol=lf
13+
14+
# Documentation files
15+
*.md text eol=lf
16+
*.rst text eol=lf
17+
*.txt text eol=lf
18+
*.cff text eol=lf
19+
20+
# SQL files
21+
*.sql text eol=lf
22+
23+
# Shell scripts
24+
*.sh text eol=lf
25+
*.bash text eol=lf
26+
27+
# Windows batch files
28+
*.bat text eol=crlf
29+
*.cmd text eol=crlf
30+
31+
# Binary files
32+
*.png binary
33+
*.jpg binary
34+
*.jpeg binary
35+
*.gif binary
36+
*.ico binary
37+
*.pdf binary
38+
*.zip binary
39+
*.tar.gz binary
40+
*.tgz binary
41+
42+
# Language specific overrides
43+
*.py linguist-language=Python
44+
*.sql linguist-language=SQL
45+
46+
# Generated files
47+
*.pyc linguist-generated=true
48+
__pycache__/ linguist-generated=true
49+
*.egg-info/ linguist-generated=true
50+
build/ linguist-generated=true
51+
dist/ linguist-generated=true
52+
53+
# Exclude from language detection
54+
*.json linguist-documentation
55+
*.yml linguist-documentation
56+
*.yaml linguist-documentation
57+
.gitattributes linguist-documentation
58+
.gitignore linguist-documentation
59+
60+
# Export ignore (what to exclude from git archive)
61+
.gitattributes export-ignore
62+
.gitignore export-ignore
63+
.github/ export-ignore
64+
tests/ export-ignore
65+
*.pyc export-ignore
66+
__pycache__/ export-ignore

‎.github-description.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# GitHub Repository Settings
2+
3+
## Repository Description
4+
🔄 PostgreSQL MCP Server – AI-Powered PostgreSQL Management & Monitoring. A powerful, AI-integrated PostgreSQL Model Context Protocol (MCP) server for automated database operations, monitoring, security, diagnostics, and optimization. Seamlessly manage PostgreSQL with 237+ tools designed for AI assistants like Claude and ChatGPT.
5+
6+
## Website URL
7+
https://github.com/mukul975/postgres-mcp-server
8+
9+
## Topics (GitHub Tags)
10+
```
11+
postgresql
12+
mcp-server
13+
ai-database-tools
14+
claude-integration
15+
chatgpt-tools
16+
database-monitoring
17+
database-management
18+
sql-automation
19+
database-diagnostics
20+
database-optimization
21+
postgres-tools
22+
ai-integration
23+
database-security
24+
query-optimizer
25+
database-health-check
26+
python-postgresql
27+
devops-automation
28+
database-admin
29+
database-performance
30+
postgres-monitoring
31+
database-maintenance
32+
ai-powered-database
33+
postgresql-mcp
34+
database-insights
35+
postgres-diagnostics
36+
database-automation
37+
model-context-protocol
38+
ai-assistant-tools
39+
database-analysis
40+
ai-powered-tools
41+
```
42+
43+
## How to Apply These Settings
44+
45+
### Option 1: GitHub Web Interface
46+
1. Go to your repository: https://github.com/mukul975/postgres-mcp-server
47+
2. Click on the "Settings" tab (⚙️ icon)
48+
3. In the "General" section, find "Repository details"
49+
4. Add the description above to the "Description" field
50+
5. Add the website URL to the "Website" field
51+
6. In the "Topics" section, add each topic from the list above (max 20 topics)
52+
7. Click "Save changes"
53+
54+
### Option 2: GitHub CLI (if you have it installed)
55+
```bash
56+
# Set repository description
57+
gh repo edit mukul975/postgres-mcp-server --description "🔄 PostgreSQL MCP Server – AI-Powered PostgreSQL Management & Monitoring. A powerful, AI-integrated PostgreSQL Model Context Protocol (MCP) server for automated database operations, monitoring, security, diagnostics, and optimization. Seamlessly manage PostgreSQL with 237+ tools designed for AI assistants like Claude and ChatGPT."
58+
59+
# Set website URL
60+
gh repo edit mukul975/postgres-mcp-server --homepage "https://github.com/mukul975/postgres-mcp-server"
61+
62+
# Add topics (you'll need to add these via the web interface as GitHub CLI doesn't support topics yet)
63+
```
64+
65+
## Additional Repository Features to Enable
66+
67+
### In Repository Settings:
68+
- ✅ Issues (for bug reports and feature requests)
69+
- ✅ Projects (for project management)
70+
- ✅ Wiki (for detailed documentation)
71+
- ✅ Discussions (for community Q&A)
72+
- ✅ Security & Analysis features
73+
74+
### Recommended Repository Labels:
75+
- `bug` - Something isn't working
76+
- `enhancement` - New feature or request
77+
- `documentation` - Improvements or additions to documentation
78+
- `help wanted` - Extra attention is needed
79+
- `good first issue` - Good for newcomers
80+
- `question` - Further information is requested
81+
- `performance` - Performance improvements
82+
- `security` - Security-related issues
83+
- `ai-integration` - AI assistant integration related
84+
- `postgresql` - PostgreSQL specific issues
85+
- `mcp` - Model Context Protocol related

‎CITATION.cff

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
type: software
4+
title: "PostgreSQL MCP Server – AI-Powered PostgreSQL Management & Monitoring"
5+
abstract: "A powerful, AI-integrated PostgreSQL Model Context Protocol (MCP) server for automated database operations, monitoring, security, diagnostics, and optimization. Seamlessly manage PostgreSQL with 237+ tools designed for AI assistants like Claude and ChatGPT."
6+
authors:
7+
- family-names: "mukul975"
8+
given-names: ""
9+
orcid: ""
10+
repository-code: "https://github.com/mukul975/postgres-mcp-server"
11+
url: "https://github.com/mukul975/postgres-mcp-server"
12+
license: MIT
13+
keywords:
14+
- "PostgreSQL"
15+
- "MCP"
16+
- "Model Context Protocol"
17+
- "AI Database Tools"
18+
- "Claude Integration"
19+
- "ChatGPT Tools"
20+
- "Database Monitoring"
21+
- "Database Management"
22+
- "SQL Automation"
23+
- "Database Diagnostics"
24+
- "Database Optimization"
25+
- "Python PostgreSQL"
26+
- "DevOps Automation"
27+
- "Database Performance"
28+
- "AI Integration"
29+
version: "1.0.0"
30+
date-released: "2024-01-01"
31+
preferred-citation:
32+
type: software
33+
title: "PostgreSQL MCP Server – AI-Powered PostgreSQL Management & Monitoring"
34+
authors:
35+
- family-names: "mukul975"
36+
given-names: ""
37+
repository-code: "https://github.com/mukul975/postgres-mcp-server"
38+
url: "https://github.com/mukul975/postgres-mcp-server"
39+
license: MIT
40+
version: "1.0.0"

‎package.json

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
{
2+
"name": "postgres-mcp-server",
3+
"version": "1.0.0",
4+
"description": "🔄 PostgreSQL MCP Server – AI-Powered PostgreSQL Management & Monitoring. A powerful, AI-integrated PostgreSQL Model Context Protocol (MCP) server for automated database operations, monitoring, security, diagnostics, and optimization. Seamlessly manage PostgreSQL with 237+ tools designed for AI assistants like Claude and ChatGPT.",
5+
"main": "postgres_server.py",
6+
"scripts": {
7+
"start": "python postgres_server.py",
8+
"test": "python test_server.py",
9+
"setup": "python setup.py",
10+
"dev": "mcp dev postgres_server.py"
11+
},
12+
"repository": {
13+
"type": "git",
14+
"url": "https://github.com/mukul975/postgres-mcp-server.git"
15+
},
16+
"homepage": "https://github.com/mukul975/postgres-mcp-server",
17+
"bugs": {
18+
"url": "https://github.com/mukul975/postgres-mcp-server/issues"
19+
},
20+
"keywords": [
21+
"postgresql",
22+
"mcp",
23+
"model-context-protocol",
24+
"ai-database-tools",
25+
"claude",
26+
"chatgpt",
27+
"database-monitoring",
28+
"database-management",
29+
"sql-automation",
30+
"database-diagnostics",
31+
"database-optimization",
32+
"postgres",
33+
"ai-integration",
34+
"database-security",
35+
"query-optimizer",
36+
"database-health-check",
37+
"python-postgresql",
38+
"devops-ai",
39+
"database-admin",
40+
"db-tools",
41+
"postgresql-server",
42+
"database-automation",
43+
"ai-assistant",
44+
"database-performance",
45+
"sql-tools",
46+
"postgres-tools",
47+
"database-analysis",
48+
"postgres-monitoring",
49+
"database-maintenance",
50+
"ai-powered-database",
51+
"postgresql-mcp",
52+
"database-insights",
53+
"postgres-diagnostics",
54+
"database-cli",
55+
"postgresql-automation"
56+
],
57+
"author": {
58+
"name": "mukul975",
59+
"url": "https://github.com/mukul975"
60+
},
61+
"license": "MIT",
62+
"engines": {
63+
"python": ">=3.8"
64+
},
65+
"os": [
66+
"win32",
67+
"darwin",
68+
"linux"
69+
],
70+
"topics": [
71+
"postgresql",
72+
"mcp-server",
73+
"ai-database-tools",
74+
"claude-integration",
75+
"chatgpt-tools",
76+
"database-monitoring",
77+
"database-management",
78+
"sql-automation",
79+
"database-diagnostics",
80+
"database-optimization",
81+
"postgres-tools",
82+
"ai-integration",
83+
"database-security",
84+
"query-optimizer",
85+
"database-health-check",
86+
"python-postgresql",
87+
"devops-automation",
88+
"database-admin",
89+
"database-performance",
90+
"postgres-monitoring",
91+
"database-maintenance",
92+
"ai-powered-database",
93+
"postgresql-mcp",
94+
"database-insights",
95+
"postgres-diagnostics",
96+
"database-automation",
97+
"model-context-protocol",
98+
"ai-assistant-tools",
99+
"database-analysis"
100+
]
101+
}

0 commit comments

Comments
 (0)