QueryForge
streamlit-dashboard-mcpserver
QueryForge — 与你的数据库对话,看着它变成仪表盘。
一个统一的模型上下文协议(MCP)服务器,让 Claude 能够查询任何 SQLite 数据库、从知识库中检索企业特定的业务逻辑,并构建实时的 Streamlit 仪表盘——全部通过一次对话完成。
项目结构
streamlit-dashboard-mcpserver/
├── .venv/ # Python virtual environment (managed by uv)
├── data/
│ ├── seed.py # Generates the sample CRM database
│ └── database.db # SQLite database (generated by seed.py)
├── knowledge_base/
│ ├── docs/ # Source documents (formulas, business rules, definitions)
│ ├── ingest.py # Chunks + embeds docs into the vector store
│ └── index/ # Persisted vector store (generated by ingest.py)
├── .python-version # Pinned Python version for uv
├── dashboard.py # Auto-generated by Claude at runtime
├── server.py # The MCP server
├── uv.lock # Dependency lock file
└── README.mdRelated MCP server: TheMCP-server
功能
工具 | 描述 |
| 列出数据库中的所有表 |
| 显示表的列、类型和约束 |
| 返回任意表的前 N 行 |
| 运行只读的 SELECT 查询 |
| 从企业文档中检索相关片段(自定义计算公式、业务规则、指标定义),帮助 Claude 编写正确的查询和仪表盘逻辑 |
| 编写 Streamlit 应用,自动安装依赖并启动 |
| 停止正在运行的 Streamlit 进程 |
| 检查仪表盘是否正在运行以及运行在哪个端口 |
| 读取当前 dashboard.py 的源代码 |
强制只读。 INSERT、UPDATE、DELETE、DROP 以及所有其他写操作都在服务器级别被阻止。知识库仅用于检索——Claude 无法通过此服务器向其中写入内容。
query_knowledge_base 是让仪表盘 正确 而非仅仅看似合理的关键。Claude 不会猜测你的组织如何定义“净收入”或“活跃客户”等概念,而是在编写 SQL 或仪表盘代码之前,从分块的企业文档中检索实际记录在案的公式。

前提条件
Python 3.11+(通过
.python-version固定)uv — 本项目已使用(参见
uv.lock)Claude Desktop
一个用于知识库的源文档文件夹(PDF、Markdown 或纯文本——例如你的内部公式表、指标术语表或标准操作流程)
安装
1. 安装 Claude Desktop
下载并安装适用于你操作系统的 Claude Desktop: Windows / macOS:https://claude.ai/download 安装后使用你的 Anthropic 账户登录。
2. 克隆仓库
HTTPS:
git clone https://github.com/your-username/streamlit-dashboard-mcpserver.git
cd streamlit-dashboard-mcpserverSSH:
git clone git@github.com:your-username/streamlit-dashboard-mcpserver.git
cd streamlit-dashboard-mcpserverGitHub CLI:
gh repo clone your-username/streamlit-dashboard-mcpserver
cd streamlit-dashboard-mcpserver3. 使用 uv 设置环境
本项目使用 uv 进行环境管理。.python-version 和 uv.lock 文件已提交,因此只需一条命令即可完成设置。
如果你还没有安装 uv:
# Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"从锁文件创建虚拟环境并安装所有依赖:
uv sync激活环境:
# Windows PowerShell
.venv\Scripts\Activate.ps1
# Windows CMD
.venv\Scripts\activate.bat激活后,你会在提示符中看到项目名称:
(streamlit-dashboard-mcpserver) PS C:\Users\benij\ds_project\streamlit-dashboard-mcpserver>验证关键包是否已安装:
pip list | findstr "mcp streamlit"如果缺少任何内容:
uv pip install mcp streamlit pandas plotly4. 生成数据库
data/ 中的 seed.py 脚本会生成一个真实的 CRM 数据库,包含 10,000+ 条记录,覆盖完整的雪花模式。
cd data
python seed.py
cd ..这将创建 data/database.db,即 MCP 服务器读取的数据库。
5. 构建知识库索引
将你的企业文档(公式表、指标定义、业务规则——PDF、Markdown 或 .txt)放入 knowledge_base/docs/,然后运行:
python knowledge_base/ingest.py该脚本会对文档进行分块和嵌入,并将生成的向量存储写入 knowledge_base/index/。这就是 query_knowledge_base 在运行时读取的内容——每当源文档发生变化时,请重新运行此脚本。
6. 配置 Claude Desktop
Claude Desktop 从 JSON 配置文件中读取 MCP 服务器定义。
打开配置文件:
notepad $env:APPDATA\Claude\claude_desktop_config.json如果文件尚不存在,记事本会询问是否创建——点击“是”。
粘贴以下配置,如果不同,请将 benij 替换为你的 Windows 用户名:
{
"mcpServers": {
"sqlite-dashboard": {
"command": "C:\\Users\\benij\\ds_project\\streamlit-dashboard-mcpserver\\.venv\\Scripts\\python.exe",
"args": [
"C:\\Users\\benij\\ds_project\\streamlit-dashboard-mcpserver\\server.py"
],
"env": {
"DB_PATH": "C:\\Users\\benij\\ds_project\\streamlit-dashboard-mcpserver\\data\\database.db",
"DASHBOARD_PORT": "8501",
"KB_INDEX_PATH": "C:\\Users\\benij\\ds_project\\streamlit-dashboard-mcpserver\\knowledge_base\\index"
}
}
}
}要确认你的确切 Python 路径,请在激活 venv 后运行:
where.exe python预期输出:
C:\Users\benij\ds_project\streamlit-dashboard-mcpserver\.venv\Scripts\python.exe使用该确切字符串作为配置中的 command 值。
始终使用绝对路径。 Claude Desktop 会从不可预测的工作目录启动 MCP 服务器子进程——相对路径将无法正确解析。
7. 重启 Claude Desktop
保存配置后,完全退出 Claude Desktop——右键单击系统托盘图标 → 退出。然后重新打开。
重新启动后,点击聊天输入框左下角的 🔨 锤子图标。你应该会看到列出的所有 9 个工具,确认服务器已连接。
使用方法
连接后,自然地与 Claude 对话:
"What tables are in my database?"
"How do we define 'net revenue' internally?"
"Show me the top 10 customers by total revenue, using our
company's official revenue formula"
"Build a dashboard with monthly sales trends, a bar chart
by product category, and a salesperson leaderboard"Claude 将探索模式,在需要时从知识库中提取相关业务逻辑,运行查询,编写 Streamlit 代码,安装任何缺失的依赖,并返回一个可在浏览器中打开的 URL——默认为 http://localhost:8501。
环境变量
在你的 claude_desktop_config.json 的 env 块中设置这些变量:
变量 | 默认值 | 描述 |
|
| 你的 SQLite 数据库的绝对路径 |
|
| Streamlit 将监听的端口 |
|
| 由 |
故障排除
🔨 锤子图标未显示在 Claude Desktop 中 配置 JSON 可能无效——尾随逗号和括号不匹配是常见错误。将其粘贴到 jsonlint.com 进行验证。任何配置更改后,务必完全退出并重新打开 Claude Desktop。
“找不到数据库”错误
确认 DB_PATH 是绝对路径,并且 database.db 存在于 data/ 文件夹中。如果尚未生成,请运行 seed.py。
query_knowledge_base 返回无结果 / 索引为空
确认 knowledge_base/docs/ 中确实有文档,然后重新运行 python knowledge_base/ingest.py。确认配置中的 KB_INDEX_PATH 指向 knowledge_base/index/。
Streamlit 页面无法加载
询问 Claude“仪表盘是否正在运行?”以调用 get_dashboard_status。如果未运行,请让 Claude 再次执行 create_dashboard。同时检查端口 8501 是否已被其他进程占用。
uv sync 失败
确保你安装的 Python 版本与 .python-version 匹配。运行 python --version 检查,如有需要,请从 python.org 安装正确的版本。
激活 .venv 时出现 PowerShell ExecutionPolicy 错误
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser然后重新激活。
关于
一个 MCP 服务器,将自然语言转化为 SQL 查询和实时的、感知业务逻辑的 Streamlit 仪表盘,由 Claude 和包含企业特定规则与公式的检索增强知识库驱动。
Available Tools
10 toolscreate_dashboardB
Creates or updates the Streamlit dashboard with the given Python code.
Automatically installs missing dependencies and starts/reloads the app.
IMPORTANT: The variable DB_PATH is automatically injected at the top of
your code — always connect to the database using:
conn = sqlite3.connect(DB_PATH)
Never hardcode a database path string yourself.
Args:
code: Full Python source code for the Streamlit dashboard
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations, so the description carries the full load. It discloses helpful side effects (auto-install dependencies, automatic DB_PATH injection) and the create-or-update dual behavior, but omits permission needs, error modes, and whether the update replaces the whole app or merges. Partial behavioral coverage.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the action, then the caveat about DB_PATH. The 'Args' block is boilerplate but short. Some redundancy between the first sentence and the later 'starts/reloads the app' clause, but overall efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be explained. The description covers the key constraint (DB_PATH) and high-level behavior, but does not address what happens on failure, dependency install scope, or how to recover a bad deploy, which matters for an agent invoking a code-writing tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0% and the only param is described minimally as 'Full Python source code for the Streamlit dashboard.' The important detail about DB_PATH injection is stated as prose rather than tied to the code parameter, and there is no guidance on structure, length, or modules allowed. With low coverage the description should compensate more.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (creates or updates) and resource (Streamlit dashboard) with the input that drives it (Python code). It does not explicitly contrast with siblings like read_dashboard or stop_dashboard, but the lifecycle role is clear from the phrasing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage through the code argument and the mention of reloading an existing app, but never states when to use this tool versus stop_dashboard/read_dashboard or what prerequisites exist. Usage is inferable rather than explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
describe_tableC
Show column names, types, and constraints for a table.
Args:
table: Name of the table to describe
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden, yet it says nothing about read-only nature, required permissions, or behavior for a nonexistent table. The statement of what is returned (columns, types, constraints) overlaps with the output schema, so it adds little behavioral disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose sentence is short and front-loaded with the key information. The appended 'Args:' block is slightly redundant for a one-parameter tool but costs little.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and this is a simple one-parameter read operation. Still, nothing addresses error cases, missing tables, or how this differs from list_tables/sample_table, leaving the definition at the minimum viable level.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, but 'Name of the table to describe' only restates the parameter name. It omits useful detail such as whether a schema qualifier is expected, case sensitivity, or how nested/qualified names are handled.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb and resource ('Show column names, types, and constraints for a table'), so an agent immediately knows it returns schema metadata. It does not, however, distinguish itself from siblings like list_tables or sample_table, which also operate on table metadata.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit when-to-use guidance and no mention of alternatives such as list_tables (for enumeration) or sample_table (for row data). Usage is only implied by the purpose statement, leaving the agent to infer the boundary between this and its siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_dashboard_statusA
Returns whether the Streamlit dashboard is running and on which port.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral burden, and it does disclose the essential trait: this is a status/read probe that returns a running flag and a port. It omits any note about authentication, side effects, or what happens when the dashboard is stopped, though for a zero-argument probe that gap is modest.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no filler; the returned information is stated immediately with zero waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so the description needn't enumerate return values, and no parameters need explaining. The only missing piece is when to reach for this tool relative to the other dashboard tools.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes no parameters, so the baseline of 4 applies; there is no parameter semantics to document. The description correctly adds no redundant parameter commentary.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a concrete verb and resource ('Returns whether the Streamlit dashboard is running and on which port'), which is specific enough to distinguish it from create_dashboard, stop_dashboard, and read_dashboard. It doesn't explicitly name those siblings, but the status-vs-operate distinction is inherent in the wording.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no guidance on when to call this versus alternatives such as read_dashboard or create_dashboard, and no preconditions. The use case (checking readiness before another dashboard operation) is only inferable, not stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
knowledge_base_infoA
Returns metadata about the current knowledge base:
total chunks, unique sources, collection name, embedding model.
Useful to verify that PDF ingestion completed successfully.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the disclosure burden. It signals a read-style metadata call and what is returned, but says nothing about permissions, behavior on an empty/uninitialized knowledge base, or whether the call has any cost or side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the return payload and followed by the motivating use case. Nothing is padded, though the value could have been sharpened slightly by naming the sibling it contrasts with.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described, and with zero parameters there is no schema gap to compensate for. The only missing element is any note on failure/empty-state behavior in the absence of annotations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there is nothing for the description to clarify; the baseline for a parameterless tool applies. The description adds no spurious parameter-like claims.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Uses a specific verb (returns) with a specific resource (knowledge base) and enumerates the returned metadata: total chunks, unique sources, collection name, embedding model. This clearly separates it from the search-oriented sibling knowledge_search, though it never names that sibling explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives an explicit purpose context: verifying that PDF ingestion completed successfully. It does not state when not to use it or point to an alternative, so it falls short of full when/when-not guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
knowledge_searchA
Semantic search over the ingested PDF knowledge base.
Pipeline:
1. Bi-encoder retrieval from ChromaDB (fast ANN search, top_k_retrieve candidates)
2. Cross-encoder reranking (precise pointwise scoring)
3. Custom composite metric computation (cosine + rerank + keyword + density)
4. Returns top_k_return chunks ranked by composite score with full metrics
The composite_score field is the primary relevance signal you should use when
deciding how much to trust each chunk. Scores > 0.7 are highly relevant.
Args:
query: Natural-language question or search phrase
top_k_retrieve: Number of candidates to fetch from the vector DB (default 20)
top_k_return: Number of final results to return after reranking (default 5)
filter_source: Optional — filter by PDF filename (e.g. "report.pdf")
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| top_k_return | No | ||
| filter_source | No | ||
| top_k_retrieve | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations, so the description carries the full burden, and it does substantial work: it discloses the retrieval/rerank/composite-score pipeline, how the composite_score should be interpreted (>0.7 highly relevant), and what the return contains. It stops short of describing permissions, latency/cost, or what happens on an empty KB.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well front-loaded: one-line purpose, then a numbered pipeline, then score interpretation, then args. Slightly verbose and the numbered pipeline is borderline display-oriented, but every section earns its place for a multi-stage tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values needn't be enumerated, and the description still adds the key interpretation rule. Combined with full param semantics and pipeline disclosure, it is complete for correct invocation; only cross-sibling routing guidance is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, and it does: it gives meaning, format and defaults for all four args, and explains the retrieve-vs-return relationship (candidate fetch vs final reranked results) plus a concrete filter_source example.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource+scope: 'Semantic search over the ingested PDF knowledge base.' The pipeline detail makes it unambiguous, and it is clearly distinguished from siblings like query_database (SQL) or knowledge_base_info (metadata).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implied usage is clear (natural-language semantic lookup over PDFs), but there is no explicit when-to-use / when-not guidance and no named alternative such as query_database for structured questions. The description doesn't route the agent among siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_tablesA
List all tables in the SQLite database.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It only states the purpose but does not disclose any behavioral traits like read-only nature or performance implications, though the operation is obviously safe.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise (five words) and front-loaded, containing no unnecessary information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given zero parameters and a presumably simple output schema, the description is sufficient. It could mention that it returns table names, but the output schema likely covers that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has no parameters and schema coverage is 100%, so the description does not need to add parameter info. It appropriately omits such details.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the action ('List') and the resource ('all tables in the SQLite database'), which is specific and clearly distinguishes from siblings like 'execute' or 'query'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use (to get all tables), but does not provide explicit guidance on when not to use or mention alternatives. For a simple tool, this is acceptable but lacks some clarity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
query_databaseB
Run a SELECT query against the SQLite database.
Only read-only SELECT statements are allowed.
Args:
sql: A valid SQLite SELECT statement
| Name | Required | Description | Default |
|---|---|---|---|
| sql | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and partially meets it by disclosing the read-only constraint ('Only read-only SELECT statements are allowed'). It does not cover error handling for non-SELECT input, permissions, or other runtime behavior, so the disclosure is useful but incomplete.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short and front-loaded: purpose first, then the key constraint, then the argument. The Args section slightly repeats the SELECT requirement from the opening line, but the overall size is appropriate with minimal waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple (one parameter) and an output schema exists, so the description need not explain return values. It covers purpose, the read-only constraint, and the parameter meaning, which is nearly sufficient; the main gap is the lack of sibling routing guidance, but that is a minor omission given the tool's straightforward scope.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It does add meaning by specifying the parameter must be a valid SQLite SELECT statement (not arbitrary SQL), but it offers no detail on result handling, parameter binding, or syntax expectations beyond that. Partial compensation, not full.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Run') and resource ('SELECT query against the SQLite database'), making the tool's function clear. It does not explicitly distinguish itself from read-oriented siblings like list_tables or sample_table, but the 'arbitrary SELECT' scope is implied well enough for an agent to infer it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description only says 'Only read-only SELECT statements are allowed' — a hard constraint, not usage guidance. It gives no indication of when to use query_database versus list_tables, describe_table, or sample_table, leaving the agent to infer routing on its own.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
read_dashboardB
Returns the current contents of dashboard.py.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden. It implies a safe, live read via 'current', but says nothing about what happens when the dashboard does not exist, permissions, or side effects. The output schema covers return values, but behavioral gaps remain.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single short sentence with the resource stated first and no filler. Every word earns its place and nothing is buried.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is simple (0 params, output schema present), so the description need not explain returns. However, it omits error behavior and any routing hint against its many siblings, leaving the definition minimally adequate rather than complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so per the baseline this scores 4. There is nothing for the description to disambiguate, and it correctly does not invent parameter detail.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb (returns) tied to a concrete resource (the contents of dashboard.py), so an agent knows this is a plain read of a file. It does not explicitly differentiate itself from siblings like get_dashboard_status, but the read-vs-status distinction is mostly inferable from the verb.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool versus the many siblings (create_dashboard, stop_dashboard, get_dashboard_status). Usage is only implied by the word 'Returns', with no conditions, prerequisites, or alternatives named.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
sample_tableB
Return the first N rows of a table (default 5, max 50).
Args:
table: Name of the table to sample
limit: Number of rows to return (default 5, max 50)
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| table | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full behavioral burden. It usefully discloses the default (5) and hard cap (max 50), but says nothing about row ordering (i.e., that 'first N' may be arbitrary without an ORDER BY), required permissions, or whether this is strictly read-only. The cap is the main behavioral fact conveyed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose line is front-loaded and the Args block is compact. The default/max values are repeated in both the opening sentence and the args list, which is mild redundancy but acceptable given the schema has no descriptions.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described. For a simple two-parameter read tool, the description covers purpose, both arguments, and the size constraint adequately; it only lacks sibling disambiguation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, and it does: both parameters are explained ('table: Name of the table to sample' and 'limit: Number of rows to return (default 5, max 50)'), including the default and constraint. Minor gap in that table-name qualification conventions (schema/catalog prefixes) are not addressed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Return the first N rows of a table'), which clearly conveys a sampling operation. It does not, however, differentiate itself from siblings like query_database or describe_table, so an agent must infer the distinction.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus query_database, describe_table, or list_tables, all of which are plausible alternatives for inspecting a table. No exclusions, prerequisites, or situational context are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
stop_dashboardB
Stops the running Streamlit dashboard process.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden, yet it only asserts that a process is stopped. It does not disclose whether the operation is idempotent when nothing is running, whether it terminates the process forcibly or gracefully, whether any session state or data is lost, or what permissions are needed for a mutation-style action.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single compact sentence with the action front-loaded and no filler. It is efficient, though it is arguably too terse for a lifecycle-mutating action, leaving room for a short usage clause without bloat.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value explanation is not required, and the zero-parameter schema is simple. However, with no annotations and a lifecycle-mutating operation, the description omits the prerequisite state and side effects an agent would need to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline is 4. The schema confirms an empty argument object, matching the description's lack of parameter discussion.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ("Stops") and resource ("the running Streamlit dashboard process"), which is unambiguous on its own. It contrasts implicitly with create_dashboard, get_dashboard_status, and read_dashboard by naming the lifecycle action, but never explicitly says how it differs from its siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives such as get_dashboard_status (which would tell you whether a dashboard is running) or create_dashboard. The phrase "the running" implies a precondition but does not state what happens if no dashboard is running or when to prefer this over a status check.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
10 tool updates
v0.1.0- First observed
create_dashboard - First observed
describe_table - First observed
get_dashboard_status - First observed
knowledge_base_info - First observed
knowledge_search - First observed
list_tables - First observed
query_database - First observed
read_dashboard - First observed
sample_table - First observed
stop_dashboard
TDQS
Scored across 10 tools
Each tool targets a distinct resource and action: table introspection (list/describe/sample), read-only querying, dashboard lifecycle management, and knowledge-base retrieval. Boundaries are clear, and the read-only query tool is explicitly separated from the preview/schema helpers.
Most tools use a predictable verb_noun pattern (list_tables, describe_table, sample_table, query_database, create_dashboard, stop_dashboard, read_dashboard). However knowledge_search and knowledge_base_info flip to a noun_verb/compound form, a minor deviation from the dominant convention.
Ten tools is well-scoped, and each earns its place within its functional group. It does span three distinct concerns (SQLite querying, Streamlit dashboard, knowledge base), which is slightly broad but still justified.
Dashboard lifecycle (create/stop/status/read) and table exploration plus read-only querying are well covered. Gaps exist: there is no knowledge-base ingestion tool despite referring to an ingested KB, and no way to modify or delete data.
Maintenance
Related MCP Connectors
MCP server unifying ERPs, CRMs, APIs and knowledge base for Claude, ChatGPT and Gemini.
Hosted SQL Server MCP server for Claude, ChatGPT and Cursor, with each action switched per account.
Query your warehouse or a CSV with Claude/ChatGPT over MCP, governed by table-level ACL + audit.
Text-to-SQL MCP server: read-only queries on PostgreSQL, MySQL and SQL Server with your real schema
Related MCP Servers
- AlicenseAqualityAmaintenanceOne config, one CLI that turns your databases (Postgres, MySQL, SQLite, MongoDB) into MCP servers for Claude, GPT, Cursor, and any MCP-compatible agent.31MIT
- FlicenseNot gradedqualityDmaintenanceEnables interaction with SQLite databases, filesystem, AWS IAM, and Gmail through a master MCP server with a Streamlit UI optimized for Claude.1-
- AlicenseAqualityDmaintenanceMCP server for Claude that connects to MySQL, MariaDB, and SQLite databases. Query your databases using natural language.3MIT
- AlicenseAqualityDmaintenanceA database-agnostic MCP server that enables natural language queries to your database through Claude or Copilot, automatically writing and executing SQL.88 npmMIT