diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a8d25ba..f235c55 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,6 +3,12 @@ contact_links: - name: cubrid-mcp-server Documentation url: https://cubrid-lab.github.io/cubrid-mcp-server/ about: Documentation site — tools, security model, multi-connection, troubleshooting + - name: Troubleshooting + url: https://github.com/cubrid-lab/cubrid-mcp-server/blob/main/docs/TROUBLESHOOTING.md + about: Fixes for common setup, connection and client problems; check here before opening an issue - name: CUBRID Documentation url: https://cubrid.org/documentation about: Official CUBRID database documentation + - name: Report a Security Vulnerability + url: https://github.com/cubrid-lab/cubrid-mcp-server/blob/main/SECURITY.md#reporting-a-vulnerability + about: Do not open a public issue; SECURITY.md describes the private email reporting route diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..61cc84c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,74 @@ +name: Question +description: Ask a usage question about cubrid-mcp-server +title: "question: " +labels: ["question", "status: needs triage"] +body: + - type: markdown + attributes: + value: | + Ask usage questions in this repository: how to install, configure, + run or troubleshoot cubrid-mcp-server. Defects go in the Bug Report + form and feature ideas in the Feature Request form; other + repositories keep separate acceptance, assignees and closure. + **House rules** + - File this question in English. + - Check the Troubleshooting guide first: + https://github.com/cubrid-lab/cubrid-mcp-server/blob/main/docs/TROUBLESHOOTING.md + - Never paste passwords, connection strings or query results you + would not publish. + - Security reports do not belong in a public issue. Email them as + described in SECURITY.md instead: + https://github.com/cubrid-lab/cubrid-mcp-server/blob/main/SECURITY.md + + - type: markdown + attributes: + value: | + Keep the `question:` title prefix and finish the title in English, + for example `question: how do I serve two databases from one + process`. You do not need to apply labels; maintainers assign + priority and size after triage. + + - type: textarea + id: environment + attributes: + label: Environment + description: Server version, Python version, CUBRID version, OS, how the server is started (uvx / pipx / venv path / source, plus the client config `command`), and the MCP client used + placeholder: | + cubrid-mcp-server: 0.x.y + Python: 3.12 + CUBRID: 11.4 (docker) + Client: Claude Desktop + Started via: uvx / pipx / .venv/bin/cubrid-mcp-server (plus the client config `command`) + OS: macOS 15 / Ubuntu 24.04 / Windows 11 + validations: + required: true + + - type: textarea + id: question + attributes: + label: Question + description: What are you trying to do, and what do you need to know? + placeholder: Describe your question as concretely as you can + validations: + required: true + + - type: textarea + id: tried + attributes: + label: What You Have Tried + description: Optional. Steps you already took, documentation you followed, and what happened + placeholder: | + 1. First step + 2. Second step + 3. ... + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context about the question here + placeholder: Config excerpts (redacted), error messages, links, etc. + validations: + required: false diff --git a/CHANGELOG.md b/CHANGELOG.md index 93394df..dc37841 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **README Quick Start lists its requirements (#485)** — `README.md` and `docs/README.ko.md` add a Requirements list before Configure: Python 3.11 or later (`requires-python`), a reachable CUBRID 10.2–11.4 broker on port 33000 (the server's supported range; installing the package does not install CUBRID) with a link to Quick Start Step 1 for a disposable one, and uv for `uvx` or pipx for `pipx run`. The Korean Quick Start's Step 1 gets the explicit `step-1-start-a-disposable-cubrid-lab` anchor, and a docs-alignment test keeps both lists in step with `pyproject.toml` and the server instructions. Documentation only; behavior is unchanged. - **Troubleshooting says where Claude Desktop keeps the server's error output (#483)** — tool results carry only an error category and the cause goes to stderr, but a Claude Desktop user has no terminal. The "No logs anywhere" entry of `docs/TROUBLESHOOTING.md` and `docs/ko/TROUBLESHOOTING.md` now names the file, `mcp-server-cubrid.log` for the README's `cubrid` key, and its folder on macOS (`~/Library/Logs/Claude`), Windows (`%APPDATA%\Claude\logs`) and Linux (`~/.config/Claude/logs`), as the MCP guide documents, keeps the `2>server.log` advice and warns that the log can contain SQL. The entry gets an explicit `no-logs-anywhere` anchor, and both Quick Start "If something fails" paragraphs point chat-client users to it. Documentation only; behavior is unchanged. - **Windows client setup next to macOS/Linux (#480)** — README, `docs/README.ko.md`, Troubleshooting and the English/Korean Quick Start now give Claude Desktop's Windows configuration file (`%APPDATA%\Claude\claude_desktop_config.json`) beside the macOS one, as the MCP guide documents, and mention Settings → Developer → Edit Config. The Quick Start's install step shows the Windows `.venv\Scripts` layout, `activate`/`Activate.ps1`, and `where` / `Get-Command` instead of `which`, labelled as not run for the walkthrough, and the chat-client section shows the `.exe` path with JSON-escaped backslashes. Documentation only; behavior is unchanged. +- **Issue chooser gains a question form and help routes (#482)** — `.github/ISSUE_TEMPLATE` adds a Question form, so usage questions file separately from defects while GitHub Discussions is disabled, and the chooser gains contact links for Troubleshooting and for SECURITY.md. The security link names the documented private email route only; it does not claim GitHub private vulnerability reporting, which is not enabled for this repository. The site Help nav and the docs index already describe the same routes, so no site text changes. Documentation only; behavior is unchanged. ### CI