Skip to content

Commit 57f21f0

Browse files
xtonyjiangxtonyjiang
committed
Initial commit
0 parents  commit 57f21f0

68 files changed

Lines changed: 8981 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug.yaml‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
name: 🐞 Bug Report
2+
description: Report a bug or issue with a database toolbox image
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for reporting an issue with the MCP Database Toolbox!
9+
10+
Before submitting, please:
11+
- Check existing issues to avoid duplicates
12+
- Review the README for common issues
13+
- Ensure you're using the latest image version
14+
15+
Please fill in as much information as possible to help us diagnose the problem.
16+
- type: dropdown
17+
attributes:
18+
label: Which database toolbox is affected?
19+
description: Select the database image experiencing the issue
20+
options:
21+
- AlloyDB for PostgreSQL
22+
- BigQuery
23+
- Bigtable
24+
- Cloud SQL (MySQL)
25+
- Cloud SQL (PostgreSQL)
26+
- Cloud SQL (SQL Server)
27+
- Couchbase
28+
- Dataplex
29+
- Dgraph
30+
- Firestore
31+
- Looker
32+
- MongoDB
33+
- MySQL
34+
- Neo4j
35+
- PostgreSQL
36+
- Redis
37+
- Redshift
38+
- Spanner
39+
- SQL Server
40+
- SQLite
41+
- TiDB
42+
- Valkey
43+
- Multiple databases
44+
- Not database-specific
45+
validations:
46+
required: true
47+
48+
- type: input
49+
attributes:
50+
label: Image Version/Tag
51+
description: Which version of the image are you using?
52+
placeholder: "e.g., v1.2.3, latest, sha-abc123"
53+
validations:
54+
required: true
55+
56+
- type: dropdown
57+
attributes:
58+
label: Architecture
59+
description: What architecture are you running on?
60+
options:
61+
- linux/amd64
62+
- linux/arm64
63+
- Unknown
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
attributes:
69+
label: Environment Details
70+
description: Provide information about your environment
71+
placeholder: |
72+
- OS: [e.g., Ubuntu 22.04, macOS 14.0, Windows 11]
73+
- Docker Version: [e.g., 24.0.5]
74+
- Container Runtime: [e.g., Docker Desktop, Podman, containerd]
75+
- MCP Client: [e.g., Claude Desktop, custom client]
76+
value: |
77+
- OS:
78+
- Docker Version:
79+
- Container Runtime:
80+
- MCP Client:
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
attributes:
86+
label: Docker Command / Configuration
87+
description: Share your docker run command or docker-compose.yml (redact sensitive credentials)
88+
placeholder: |
89+
docker run --rm -i \
90+
--name mcp-postgres \
91+
-e DATABASE_HOST=localhost \
92+
-e DATABASE_PORT=5432 \
93+
ghcr.io/usacognition/postgres-toolbox:latest \
94+
--prebuilt postgres \
95+
--stdio
96+
render: bash
97+
validations:
98+
required: true
99+
100+
- type: textarea
101+
attributes:
102+
label: Steps to Reproduce
103+
description: Provide step-by-step instructions to reproduce the bug
104+
placeholder: |
105+
1. Start the container with command X
106+
2. Connect using MCP client Y
107+
3. Execute query Z
108+
4. Observe error
109+
validations:
110+
required: true
111+
112+
- type: textarea
113+
attributes:
114+
label: Expected Behavior
115+
description: What did you expect to happen?
116+
placeholder: The image should connect successfully and execute queries
117+
validations:
118+
required: true
119+
120+
- type: textarea
121+
attributes:
122+
label: Actual Behavior
123+
description: What actually happened? Include error messages, stack traces, or logs
124+
placeholder: |
125+
Error: Connection refused
126+
Stack trace: ...
127+
render: shell
128+
validations:
129+
required: true
130+
131+
- type: textarea
132+
attributes:
133+
label: Logs
134+
description: Paste relevant container logs (use `docker logs container-name`)
135+
render: shell
136+
137+
- type: checkboxes
138+
attributes:
139+
label: Issue Type
140+
description: What type of issue is this? (Check all that apply)
141+
options:
142+
- label: Connection issue (cannot connect to database)
143+
- label: Authentication/credential issue
144+
- label: Query execution error
145+
- label: MCP protocol issue (--stdio mode)
146+
- label: Performance issue
147+
- label: Image build/startup failure
148+
- label: Environment variable not working
149+
- label: Multi-architecture issue
150+
- label: Documentation gap
151+
152+
- type: textarea
153+
attributes:
154+
label: Additional Context
155+
description: Any other relevant information, workarounds you've tried, or related issues

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 📚 Documentation
4+
url: https://github.com/usacognition/database-toolbox/blob/main/README.md
5+
about: Read the comprehensive README with examples for all databases
6+
- name: 💬 Discussions
7+
url: https://github.com/usacognition/database-toolbox/discussions
8+
about: Community discussions, Q&A, and general chat
9+
- name: 🔒 Security Issue
10+
url: https://github.com/usacognition/database-toolbox/security/advisories/new
11+
about: Report a security vulnerability privately

‎.github/ISSUE_TEMPLATE/feature.yaml‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
name: "🚀 Feature Request"
2+
description: Suggest a new feature or enhancement for the database toolbox
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for suggesting an improvement to the MCP Database Toolbox!
9+
10+
We welcome ideas for:
11+
- New database support
12+
- Enhanced functionality for existing databases
13+
- Performance improvements
14+
- Security enhancements
15+
- Documentation improvements
16+
17+
Please provide as much detail as possible.
18+
- type: dropdown
19+
attributes:
20+
label: Feature Category
21+
description: What type of feature are you requesting?
22+
options:
23+
- New database support
24+
- Enhancement to existing database
25+
- Performance improvement
26+
- Security enhancement
27+
- New MCP capabilities
28+
- Documentation improvement
29+
- CI/CD or infrastructure
30+
- Developer experience
31+
- Other
32+
validations:
33+
required: true
34+
35+
- type: dropdown
36+
attributes:
37+
label: Which database(s) does this affect?
38+
description: Select the database(s) this feature relates to
39+
options:
40+
- AlloyDB for PostgreSQL
41+
- BigQuery
42+
- Bigtable
43+
- Cloud SQL (MySQL)
44+
- Cloud SQL (PostgreSQL)
45+
- Cloud SQL (SQL Server)
46+
- Couchbase
47+
- Dataplex
48+
- Dgraph
49+
- Firestore
50+
- Looker
51+
- MongoDB
52+
- MySQL
53+
- Neo4j
54+
- PostgreSQL
55+
- Redis
56+
- Redshift
57+
- Spanner
58+
- SQL Server
59+
- SQLite
60+
- TiDB
61+
- Valkey
62+
- New database (not yet supported)
63+
- All databases
64+
- Not database-specific
65+
validations:
66+
required: true
67+
68+
- type: dropdown
69+
attributes:
70+
label: Priority
71+
description: How important is this feature to you?
72+
options:
73+
- Nice to have
74+
- Would be helpful
75+
- Important for my use case
76+
- Critical - blocking my adoption
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
attributes:
82+
label: Problem Statement
83+
description: What problem does this feature solve? What pain point are you experiencing?
84+
placeholder: |
85+
Currently, I cannot... because...
86+
This makes it difficult to...
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
attributes:
92+
label: Proposed Solution
93+
description: Describe the feature you'd like to see. Be as specific as possible.
94+
placeholder: |
95+
I would like the ability to...
96+
This could work by...
97+
Example usage:
98+
```bash
99+
docker run ... --new-flag value
100+
```
101+
validations:
102+
required: true
103+
104+
- type: textarea
105+
attributes:
106+
label: Use Case / Example
107+
description: Provide a concrete example of how you would use this feature
108+
placeholder: |
109+
I want to connect to a Cassandra database from my MCP client.
110+
111+
Example configuration:
112+
```yaml
113+
database:
114+
type: cassandra
115+
hosts: ["node1", "node2"]
116+
keyspace: my_keyspace
117+
```
118+
119+
- type: textarea
120+
attributes:
121+
label: Alternatives Considered
122+
description: What alternative solutions or workarounds have you considered?
123+
placeholder: |
124+
- I tried using X, but it doesn't support Y
125+
- I could manually do Z, but that's not scalable
126+
127+
- type: checkboxes
128+
attributes:
129+
label: Additional Requirements
130+
description: Are there specific requirements for this feature?
131+
options:
132+
- label: Must support both amd64 and arm64 architectures
133+
- label: Must work with MCP --stdio mode
134+
- label: Must support environment variable configuration
135+
- label: Must include documentation and examples
136+
- label: Should have automated tests
137+
- label: Must maintain backward compatibility
138+
139+
- type: checkboxes
140+
attributes:
141+
label: Contribution
142+
description: Are you willing to contribute to this feature?
143+
options:
144+
- label: I'd be willing to submit a PR for this feature
145+
- label: I'd be willing to help test this feature
146+
- label: I'd be willing to help with documentation
147+
148+
- type: textarea
149+
attributes:
150+
label: Additional Context
151+
description: Any other context, screenshots, or references that would help

0 commit comments

Comments
 (0)