Skip to content

Commit 2016693

Browse files
TimothyDingTimothyDing
committed
初始化仓库
0 parents  commit 2016693

File tree

10 files changed

+1106
-0
lines changed

10 files changed

+1106
-0
lines changed

‎LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Hologres MCP Server
2+
3+
Hologres MCP Server 是 AI Agent 与 Hologres 数据库之间的通用接口。可以快速实现 AI Agent与 Hologres的无缝通信，帮助 AI Agent获取Hologres数据库的元数据，和执行SQL完成各类操作。
4+
5+
## 配置
6+
7+
MCP server 配置
8+
9+
```json
10+
{
11+
"mcpServers": {
12+
"hologres-mcp-server": {
13+
"command": "uv",
14+
"args": [
15+
"--directory",
16+
"/path/to/hologres-mcp-server",
17+
"run",
18+
"hologres-mcp-server"
19+
],
20+
"env": {
21+
"HOLOGRES_HOST": "host",
22+
"HOLOGRES_PORT": "port",
23+
"HOLOGRES_USER": "access_id",
24+
"HOLOGRES_PASSWORD": "access_key",
25+
"HOLOGRES_DATABASE": "database"
26+
}
27+
}
28+
}
29+
}
30+
```
31+
32+
## 组件
33+
34+
### Tools
35+
36+
* `excute_sql`: 在Hologres中执行查询
37+
38+
* `analyze_table`: 收集表的统计信息
39+
40+
* `get_query_plan`: 获取查询的查询计划
41+
42+
* `get_execution_plan`: 获取查询的执行计划
43+
44+
### Resources
45+
46+
#### Resources
47+
48+
* `hologres:///schemas`: 获取数据库中所有的 Schema
49+
50+
* `hologres:///system_info/missing_stats_tables`: 获取数据库中所有缺失统计信息的表
51+
52+
#### Resource Templates
53+
54+
* `hologres:///{schema}/tables`: 显示 Schema 下所有表的清单
55+
56+
* `hologres:///{schema}/{table}/ddl`: 获取表的 DDL
57+
58+
* `hologres:///{schema}/{table}/statistic`: 显示表已经采集的统计信息
59+
60+
* `hologres:///system_info/latest_query_log/{row_limits}`: 查看最近的查询日志
61+
62+
* `hologres:///system_info/user_query_log/{user}`: 显示特定用户的查询日志
63+
64+
* `hologres:///system_info/application_query_log/{application}`: 显示特定应用的查询日志
65+
66+
### Prompts
67+
68+
暂无

‎RELEASE_NOTES.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Release Notes
2+
3+
## 版本 0.1.0 (初始化版本)
4+
5+
### 描述
6+
7+
Hologres MCP Server 是 AI Agent 与 Hologres 数据库之间的通用接口。可以快速实现 AI Agent与 Hologres的无缝通信，帮助 AI Agent获取Hologres数据库的元数据，和执行SQL完成各类操作。
8+
9+
### 主要功能
10+
11+
- **执行SQL**
12+
- 在Hologers中执行SQL，包括 DDL、DML 和查询
13+
- 执行ANALYZE命令，收集统计信息
14+
15+
- **数据库元数据**
16+
- 显示所有的Schema
17+
- 显示Schema下所有的表
18+
- 显示表的DDL
19+
- 查看表的统计信息
20+
21+
- **系统信息**
22+
- 查询 Query Log
23+
- 查询缺失的统计信息
24+
25+
### 依赖
26+
27+
- Python 3.13 或更高版本
28+
- 依赖
29+
- mcp >= 1.4.0
30+
- psycopg2 >= 2.9.5
31+
32+
### 配置
33+
34+
MCP Server 必须配置以下环境变量，以连接 Hologres 实例
35+
36+
- `HOLOGRES_HOST`
37+
- `HOLOGRES_PORT`
38+
- `HOLOGRES_USER`
39+
- `HOLOGRES_PASSWORD`
40+
- `HOLOGRES_DATABASE`
41+
42+
### 安装
43+
44+
可以使用如下安装包安装 MCP Server
45+
46+
```bash
47+
pip install /path/to/dist/hologres_mcp_server-0.1.0-py3-none-any.whl
48+
```
49+
50+
### MCP 集成
51+
52+
在 Client 端的 MCP 配置文件中增加如下配置，用以配置 MCP Server
53+
54+
```json
55+
{
56+
"mcpServers": {
57+
"hologres-mcp-server": {
58+
"command": "uv",
59+
"args": [
60+
"--directory",
61+
"/path/to/hologres-mcp-server",
62+
"run",
63+
"hologres-mcp-server"
64+
],
65+
"env": {
66+
"HOLOGRES_HOST": "host",
67+
"HOLOGRES_PORT": "port",
68+
"HOLOGRES_USER": "access_id",
69+
"HOLOGRES_PASSWORD": "access_key",
70+
"HOLOGRES_DATABASE": "database"
71+
}
72+
}
73+
}
74+
}
75+
```

‎hologres_mcp_log.out

Whitespace-only changes.

‎package-lock.json

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"name": "hologres_mcp_server",
3+
"version": "1.0.0",
4+
"description": "A MCP Server for Hologres",
5+
"main": "index.js",
6+
"scripts": {
7+
"test": "echo \"Error: no test specified\" && exit 1"
8+
},
9+
"keywords": [],
10+
"author": "",
11+
"license": "ISC"
12+
}

‎pyproject.toml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[project]
2+
name = "hologres-mcp-server"
3+
version = "0.1.0"
4+
description = "A MCP Server for Hologres"
5+
readme = "README.md"
6+
requires-python = ">=3.13"
7+
dependencies = [
8+
"httpx>=0.28.1",
9+
"mcp>=1.4.1",
10+
"python-dotenv>=1.0.1",
11+
"psycopg2>=2.9.5",
12+
]
13+
[[project.authors]]
14+
name = "TimothyDing"
15+
email = "[email protected]"
16+
17+
[build-system]
18+
requires = [ "hatchling",]
19+
build-backend = "hatchling.build"
20+
21+
[project.scripts]
22+
hologres-mcp-server = "hologres_mcp_server:main"

0 commit comments

Comments
 (0)