Skip to content

Commit 9bee8f9

Browse files
committed
update docs
1 parent 37a18c5 commit 9bee8f9

File tree

3 files changed

+7
-33
lines changed

3 files changed

+7
-33
lines changed

README.md

Lines changed: 5 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,6 @@
99
![Case](https://s3.bmp.ovh/imgs/2025/07/02/7de2a851031f6913.png)
1010

1111

12-
---
13-
14-
## 工具介绍
15-
16-
### 可用工具
17-
18-
1. **list_data** - 获取当前APIKEY下的所有可用数据库(数据源)信息
19-
- **输入示例**:我数据库中有哪些数据源?
20-
- **输出**:数据源信息列表,包含数据源ID、数据库引擎、数据库描述
21-
- **使用场景**:查看用户权限下的所有数据源,获取数据源ID用于后续查询
22-
23-
2. **query** - 根据用户的问题,直接返回数据结果
24-
- **输入示例**
25-
- "请给我出销售额前10的产品"
26-
- "昨天的订单总金额是多少"
27-
- "每个部门有多少员工"
28-
- **输出**:查询的实际数据结果
29-
- **使用场景**:需要直接获取查询答案,不关心SQL细节
30-
31-
3. **gen_sql** - 根据用户查询生成对应的SQL语句
32-
- **输入示例**
33-
- "生成可以找出销售额前10的产品的sql"
34-
- "我需要查询昨天的订单总金额的sql"
35-
- "统计每个部门的员工数量的sql"
36-
- **输出**:生成的SQL语句
37-
- **使用场景**:需要查看生成的SQL语句,进行SQL审查或调试
3812

3913
---
4014

@@ -47,7 +21,7 @@
4721

4822
1. **获取 API 密钥和数据源 ID**
4923
- 登录 [AskTable](https://www.asktable.com/)
50-
- 在设置中获取您的 API 密钥(apikey)
24+
- 在设置中获取您的 API 密钥(api_key)
5125
- 选择要连接的数据源,获取数据源 ID(datasource_id)
5226

5327
2. **配置 MCP 客户端(推荐 SSE 方式)**
@@ -56,15 +30,15 @@
5630
"mcpServers": {
5731
"asktable": {
5832
"type": "sse",
59-
"url": "https://mcp.asktable.com/sse/?apikey=ASKER_8H8DRJCH6LT8HCJPXOH4&datasource_id=ds_6iewvP4cpSyhO76P2Tv8MW",
33+
"url": "https://mcp.asktable.com/sse/?api_key=ASKER_8H8DRJCH6LT8HCJPXOH4&datasource_id=ds_6iewvP4cpSyhO76P2Tv8MW",
6034
"headers": {},
6135
"timeout": 300,
6236
"sse_read_timeout": 300
6337
}
6438
}
6539
}
6640
```
67-
> 注意: 上述 URL 中的 apikey 和 datasoruce_id 是在 AskTable.com 官网的演示项目和数据,可以直接拿来测试。比如问,总共多少学生?
41+
> 注意: 上述 URL 中的 api_key 和 datasoruce_id 是在 AskTable.com 官网的演示项目和数据,可以直接拿来测试。比如问,总共多少学生?
6842
6943
3. **开始使用**
7044
- 重启您的 MCP 客户端
@@ -112,7 +86,7 @@ uvx asktable-mcp-server@latest
11286
"mcpServers": {
11387
"asktable": {
11488
"type": "sse",
115-
"url": "http://your_local_host:port/mcp/sse/?apikey=your_api_key&datasource_id=your_datasource_id",
89+
"url": "http://your_local_host:port/mcp/sse/?api_key=your_api_key&datasource_id=your_datasource_id",
11690
"headers": {},
11791
"timeout": 300,
11892
"sse_read_timeout": 300
@@ -122,7 +96,7 @@ uvx asktable-mcp-server@latest
12296
```
12397

12498
**参数说明**
125-
- `apikey`:AskTable API 密钥(必需)
99+
- `api_key`:AskTable API 密钥(必需)
126100
- `datasource_id`:数据源ID(必需)
127101

128102
### 方式四:本地部署 Stdio 模式(需要安装包)

src/asktable_mcp_server/schemas.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def get_home_page_html(version: str, base_url: str, path_prefix: str) -> str:
7979
"mcpServers": {{
8080
"asktable": {{
8181
"type": "sse",
82-
"url": "{base_url}{path_prefix}/sse/?apikey=YOUR_API_KEY&datasource_id=YOUR_DATASOURCE_ID",
82+
"url": "{base_url}{path_prefix}/sse/?api_key=YOUR_API_KEY&datasource_id=YOUR_DATASOURCE_ID",
8383
"headers": {{}},
8484
"timeout": 300,
8585
"sse_read_timeout": 300

src/asktable_mcp_server/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.2.22"
1+
__version__ = "0.2.23"

0 commit comments

Comments
 (0)