mydb-kingbase-mcp 0.3.0__tar.gz

mydb_kingbase_mcp-0.3.0/.gitignore

@@ -0,0 +1,24 @@
+# Python
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+
+# Virtual environment
+.venv/
+.venv*/
+venv/
+
+# Tool caches
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+
+# Editor swap files
+*.swp
+*.swo
+*~
+
+# IDE
+.vscode/
+.idea/

mydb_kingbase_mcp-0.3.0/.workbuddy/memory/2026-09-27.md

@@ -0,0 +1,94 @@
+# 2026-09-27 工作日志
+
+## 基于 KES MCP 创建 WorkBuddy 金仓数据库连接器
+
+将 `mydb-kes-mcp`（KingbaseES MCP Server v0.3.0）包装为 WorkBuddy 可用的连接器 `kingbase-kes`。
+
+### 产出
+
+- `connector/kingbase-kes/` — 连接器插件包（plugin.json / mcp.json / icon.svg / skills）
+- `connector/.codebuddy-plugin/marketplace.json` — 本地 marketplace 清单（名称 `mydb-connectors`）
+- `connector/mcp_handshake_test.py` — stdio 握手冒烟测试脚本
+- `~/.workbuddy/mcp.json` — 新增 `kingbase-kes` stdio MCP 服务器
+- `~/.workbuddy/plugins/known_marketplaces.json` — 注册本地目录 marketplace `mydb-connectors`
+
+### 环境
+
+- `uv venv --python 3.12` → `.venv`（Python 3.12.14）
+- `uv pip install .` 首次因网络超时失败（`typing-extensions` 下载中断）；
+  改用 `UV_HTTP_TIMEOUT=180 UV_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple` 成功
+- ksycopg2 2.9.1（for Python3.12 Kingbase V9）验证导入正常
+- 启动命令：`.venv/Scripts/python.exe -m kingbase_mcp --access-mode restricted`
+
+### 验证结果
+
+stdio 握手通过：协议 2025-06-18，暴露 10 个工具（list_schemas、list_objects、
+get_object_details、explain_query、analyze_workload_indexes、analyze_query_indexes、
+analyze_db_health、get_top_queries、analyze_db_config、execute_sql）与 2 个资源
+（kingbase://server/info、kingbase://schema/overview）。
+未配置真实数据库时服务器仍会启动，仅打印连接失败告警。
+
+### 真实连接测试（2026-09-27 08:38）
+
+使用真实连接串 `kingbase://mcp_demo:***@192.168.59.20:54321/kingbase` 跑通端到端：
+- 实例版本 **KingbaseES V009R200C013PS002**，库名 kingbase
+- list_schemas：9 个 schema（含 public、sys_catalog、pg_catalog 等）
+- list_objects(public,table)：demo_customers / demo_orders / demo_products
+- execute_sql(SELECT 1)：正常返回
+- analyze_db_health 逐项（buffer/index/connection/vacuum/sequence/replication/constraint）
+  全部 OK；其中发现若干重复索引（kwr_* 表），缓冲区命中率 99.5%
+
+注意：`DATABASE_URI` 已写入 `~/.workbuddy/mcp.json`，**明文包含密码**，
+生产/交付前建议替换为环境变量或轮换该账号密码。
+
+已知限制：restricted 模式连接池上限 5；一次性跑 `all` 或多类合并
+（如 `buffer,index`）偶发 "connection pool exhausted"，逐类单独调用稳定通过。
+
+### 待办
+
+- 连接器需在 WorkBuddy 连接器管理页「信任」启用
+- 明文密码安全：建议环境变量化或轮换 mcp_demo 账号密码
+- **开放平台上架前置**：需先将 `kingbase-mcp` 发布到 PyPI（`uv build` + `twine upload`），
+  否则 `uvx kingbase-mcp` 在用户侧拉取不到
+
+### 经验
+
+WorkBuddy 连接器包结构：`mcp.json`（`$schema` 指向 agent-plugins.org 1.0.0 mcp.schema.json，
+`mcpServers` 下声明 type/command/args/env）+ `.codebuddy-plugin/plugin.json`
+（`extensions.ai.workbuddy.display` 提供中英文名称/描述/示例，`policy.visible_in` 控制可见范围）
++ `ai.workbuddy/assets/icon.svg`（64x64）+ 可选 `skills/`。
+
+### 整理产物 → 开放平台发布就绪（2026-09-27 08:48）
+
+- 重构目录：测试脚本移入 `connector/tools/`；`kingbase-kes/` 作为**上传单元**保持干净
+  （mcp.json / plugin.json / icon.svg / skills / README）。
+- `mcp.json` 改为可移植 `uvx kingbase-mcp`（对齐官方 zwcad-mcp 本地 Python 模式），
+  `DATABASE_URI` 用 `${DATABASE_URI}` 占位，平台启用时自动弹窗配置。
+- `plugin.json` 补充 `setup.runtime`（`python >=3.12`）、keywords 增 `人大金仓`/`postgresql`/`sql`；
+  中英文 display 已齐。
+- 配套 `SKILL.md` frontmatter 补全发布元数据（author=少安事务所、display_name、category=开发工具、
+  website、avatar、version），与 mydb-kingbase-skills / mydb-yashandb-skills 同规范。
+- 新增 `kingbase-kes/README.md`（总览/安装/配置/工具/安全/FAQ）与 `connector/README.md`
+  （打包与 open.workbuddy.cn 上传指南 + 10 项检查清单）。
+- 注：本地已验证的 `~/.workbuddy/mcp.json` 仍用 venv 绝对路径 + 真实连接串（开发模式），
+  与上传包 `uvx` 写法不同；切勿将含密码的明文配置提交到仓库/平台。
+
+开放平台连接器可移植性结论：本地 Python 连接器标准做法是用 `uvx <pypi包>` 而非本机绝对路径；
+变量替换 `${VAR}` 在 env/url 模板中有效，用于收集用户配置（如 dcs-cloud 的 `${DCS_PAT}`）。
+
+### PyPI 包名重命名（2026-09-27 11:36，方案①）
+
+为避免商标敏感并统一 mydb-* 品牌，将 PyPI 分发名与控制台脚本由 `kingbase-mcp` 改为
+`mydb-kingbase-mcp`：
+- `pyproject.toml`：`name=mydb-kingbase-mcp`、`authors=少安事务所 <shawnyan@shawnyan.cn>`、
+  `[project.scripts] mydb-kingbase-mcp = "kingbase_mcp:main"`、已知首方 `kingbase_mcp`。
+- `connector/kingbase-kes/mcp.json`：`args[0]` → `mydb-kingbase-mcp`（uvx 拉取名）。
+- 文档（root README + connector 两份 README）中 `kingbase-mcp` → `mydb-kingbase-mcp`。
+- **未改**：内部模块名 `kingbase_mcp`、MCP 服务器自报名 `kingbase-mcp`（server.py）、
+  连接器名 `kingbase-kes`、safe_sql 注释前缀 `/* kingbase-mcp */`、tests/openspec。
+- 已 `uv build` 重建（dist 现含 `mydb_kingbase_mcp-0.3.0.{whl,tar.gz}`），
+  venv 重新安装为 `mydb-kingbase-mcp==0.3.0`，控制台脚本 `mydb-kingbase-mcp --help` 正常，
+  `python -m kingbase_mcp` 与本地握手测试（10 工具）均通过。
+- 顺手修复：测试脚本移入 `connector/tools/` 后 `PROJECT` 路径少算一级，已改为 `parent*3`。
+- 待办：发布到 PyPI 时包名即 `mydb-kingbase-mcp`；下次发版递增版本号。
+- 备注：Apache-2.0 派生自 Johann Schleier-Smith 的 kingbase-mcp，应保留许可证并可加 NOTICE 注明来源。

mydb_kingbase_mcp-0.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

mydb_kingbase_mcp-0.3.0/NOTICE

@@ -0,0 +1,17 @@
+mydb-kingbase-mcp
+Copyright 2026 少安事务所 (Shawn Yan) <shawnyan@shawnyan.cn>
+https://shawnyan.cn
+
+This product includes software derived from the "kingbase-mcp" project.
+
+Original work:
+  Copyright 2025 Johann Schleier-Smith <jssmith@crystal.cloud>
+  Copyright 2025 Kingbase
+  Originally licensed under the Apache License, Version 2.0.
+
+The original "kingbase-mcp" project and this derivative are both distributed
+under the Apache License, Version 2.0 (see the accompanying LICENSE file).
+This NOTICE file is included per Section 4(d) of the Apache License 2.0 to
+preserve attribution notices from the original work.
+
+Apache License 2.0: http://www.apache.org/licenses/LICENSE-2.0