Skip to main content

asktable_mcp_server project

Project description

Asktable-MCP-Server

Case

Python Version PyPI Version

asktable-mcp-server 是为 AskTable 提供的 MCP 服务,支持通过 Stdio 或 SSE 协议与 AskTable SaaS 或本地部署服务交互。

Case


工具介绍

可用工具

  1. list_data - 获取当前APIKEY下的所有可用数据库(数据源)信息

    • 输入示例:我数据库中有哪些数据源?
    • 输出:数据源信息列表,包含数据源ID、数据库引擎、数据库描述
    • 使用场景:查看用户权限下的所有数据源,获取数据源ID用于后续查询
  2. query - 根据用户的问题,直接返回数据结果

    • 输入示例
      • "请给我出销售额前10的产品"
      • "昨天的订单总金额是多少"
      • "每个部门有多少员工"
    • 输出:查询的实际数据结果
    • 使用场景:需要直接获取查询答案,不关心SQL细节
  3. gen_sql - 根据用户查询生成对应的SQL语句

    • 输入示例
      • "生成可以找出销售额前10的产品的sql"
      • "我需要查询昨天的订单总金额的sql"
      • "统计每个部门的员工数量的sql"
    • 输出:生成的SQL语句
    • 使用场景:需要查看生成的SQL语句,进行SQL审查或调试

用户配置指南

方式一:SaaS SSE 模式(推荐新用户)

如果您使用的是 AskTable SaaS 服务,推荐使用 SSE 方式,无需安装任何软件。

  1. 获取 API 密钥和数据源 ID

    • 登录 AskTable
    • 在设置中获取您的 API 密钥(apikey)
    • 选择要连接的数据源,获取数据源 ID(datasource_id)
  2. 配置 MCP 客户端(推荐 SSE 方式)

    {
      "mcpServers": {
        "asktable": {
          "type": "sse",
          "url": "https://mcp.asktable.com/sse/?apikey=ASKER_8H8DRJCH6LT8HCJPXOH4&datasource_id=ds_6iewvP4cpSyhO76P2Tv8MW",
          "headers": {},
          "timeout": 300,
          "sse_read_timeout": 300
        }
      }
    }
    

    注意: 上述 URL 中的 apikey 和 datasoruce_id 是在 AskTable.com 官网的演示项目和数据,可以直接拿来测试。比如问,总共多少学生?

  3. 开始使用

    • 重启您的 MCP 客户端
    • 现在可以使用 AskTable 的所有功能了!

方式二:SaaS Stdio 模式(需要安装包)

如果您使用 SaaS 服务但希望使用 Stdio 模式,需要本地安装包。

1. 安装包

# 使用 uv 安装
uvx asktable-mcp-server@latest

2. 配置 MCP 客户端

{
  "mcpServers": {
    "asktable": {
      "command": "uvx",
      "args": ["asktable-mcp-server@latest"],
      "env": {
        "API_KEY": "ASKER_8H8DRJCH6LT8HCJPXOH4",
        "DATASOURCE_ID": "ds_6iewvP4cpSyhO76P2Tv8MW"
      }
    }
  }
}

环境变量说明

  • API_KEY:AskTable API 密钥(必需)
  • DATASOURCE_ID:数据源ID(必需)

方式三:本地部署 SSE 模式

如果您使用 AskTable 本地部署版本,推荐使用 SSE 方式,在 AskTable 的 All-in-One 镜像中已经包含了 MCP SSE Server,默认地址是http://your_local_host:port/mcp/sse

配置 MCP 客户端

{
  "mcpServers": {
    "asktable": {
      "type": "sse",
      "url": "http://your_local_host:port/mcp/sse/?apikey=your_api_key&datasource_id=your_datasource_id",
      "headers": {},
      "timeout": 300,
      "sse_read_timeout": 300
    }
  }
}

参数说明

  • apikey:AskTable API 密钥(必需)
  • datasource_id:数据源ID(必需)

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

如果您使用本地部署但希望使用 Stdio 模式,需要本地安装包并配置 base_url。

1. 安装包

# 使用 uv 安装
uvx asktable-mcp-server@latest

2. 配置 MCP 客户端

{
  "mcpServers": {
    "asktable": {
      "command": "uvx",
      "args": ["asktable-mcp-server@latest"],
      "env": {
        "API_KEY": "your_api_key",
        "DATASOURCE_ID": "your_datasource_id",
        "BASE_URL": "http://your_local_host:port/api"
      }
    }
  }
}

环境变量说明

  • API_KEY:AskTable API 密钥(必需)
  • DATASOURCE_ID:数据源ID(必需)
  • BASE_URL:本地部署服务地址(必需)

自建 SSE 服务(高级用户)

Docker 部署(推荐)

使用官方镜像

# 拉取镜像
docker pull registry.cn-shanghai.aliyuncs.com/datamini/asktable-mcp-server:latest

# 运行容器
docker run -d \
  --name asktable-mcp-server \
  -p 8095:8095 \
  -e API_KEY=your_api_key \
  -e DATASOURCE_ID=your_datasource_id \
  -e BASE_URL=http://your_local_ip:port/api \
  registry.cn-shanghai.aliyuncs.com/datamini/asktable-mcp-server:latest

如需进一步帮助,请查阅官方文档或联系我们。

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asktable_mcp_server-0.2.9.tar.gz (92.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asktable_mcp_server-0.2.9-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file asktable_mcp_server-0.2.9.tar.gz.

File metadata

  • Download URL: asktable_mcp_server-0.2.9.tar.gz
  • Upload date:
  • Size: 92.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for asktable_mcp_server-0.2.9.tar.gz
Algorithm Hash digest
SHA256 0f4d5975be8edf885b3297f1e799c1ed815298a9d39ac1cc36d8e510d3c53586
MD5 7a7caa7f1c83a4c4ba37771879ac5d39
BLAKE2b-256 d2b903406738547c247cc1c51e789518949064a1bb9f5d2f20a2171eb6a5fd43

See more details on using hashes here.

File details

Details for the file asktable_mcp_server-0.2.9-py3-none-any.whl.

File metadata

File hashes

Hashes for asktable_mcp_server-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 6b722acb87cd766965c2d3a37ae5afaad27cdb501489b48dfd07d023be34ae18
MD5 e463e32ff5406e3f882e0ed4b0b28c91
BLAKE2b-256 b6bd1448c92f293164234ddf6e930665bd3b90c22a0dd16574c212adf7233967

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page