redshift-comment-mcp
This server provides a read-only MCP interface to an Amazon Redshift cluster, focused on discovering and understanding data through database comments rather than trusting object names.
List metadata:
list_schemas,list_tables,list_columns— paginated listing of schemas, tables, and columns, with optional inline comments and parent-object comments.Search metadata:
search_schemas,search_tables,search_columns— keyword search over names and comments, scoped by schema/table where useful.Retrieve comments:
get_schema_comment,get_table_comment,get_column_comment,get_all_column_comments— authoritative business meaning for objects.Run read-only queries:
execute_sql— executesSELECT/WITHstatements only, with paginated results; DDL/DML are rejected.Bootstrap configuration:
setup_via_dialog— collect host/user/dbname via chat and password via an OS-native dialog, then test and save the profile.Check configuration state:
get_setup_status— non-secret, read-only status of whether a profile is configured and how connections resolve.
Provides read-only access to Amazon Redshift, with tools for listing schemas, tables, and columns, searching across metadata, executing SELECT/WITH queries, and skills for column profiling, schema exploration, lineage reconstruction from query history, and keyword-based column/table search.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@redshift-comment-mcpProfile the column 'status' in table dbt_marts.fct_orders"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
redshift-comment-mcp
A read-only Model Context Protocol server for Amazon Redshift, plus a Claude Code plugin with 6 slash-command skills built on top. Designed around one assertion: column names lie, comments don't — so the server exposes comments aggressively and the skills compose those tools into the discovery workflows you actually do every day.
"What values does dbt_marts.fct_orders.status really hold?"
→ /redshift-profile dbt_marts.fct_orders status
→ cardinality, top-N, null rate, min/max, existing comment — one round.Why this exists
If you've ever opened an unfamiliar Redshift table and squinted at
column names like f3, legacy_id_v2, or status (which status?),
you already know the pain. dbt manifests are too narrow. Web GUIs
are too slow. Hand-written SQL is too repetitive.
This plugin's charter is Guided Data Discovery:
Comments first. Every list / search tool returns the column, table, or schema comment when asked — names are advisory, comments are authoritative.
Read-only by construction.
execute_sqlrejects DDL / DML at the parse layer; no skill in this repo can mutate Redshift.MCP-composed skills. New workflows are built by stringing together existing tools, not by adding new database connections.
No persistence. No synthesis layer, no
.redshift-wiki/markdown, no stale tracking. Persistence belongs in a separate plugin.
See implementation_guide.md §1.2 for the
full charter.
Related MCP server: redshift-utils-mcp
What you get
MCP tools (13, defined in src/redshift_comment_mcp/)
Group | Tools |
List |
|
Search (hit-count ranked) |
|
Comment retrieval |
|
Query |
|
Setup (since v0.7.0) |
|
Pagination on every list / search; explicit WARNING strings nudging
the LLM to read comments before trusting names.
Slash-command skills (6, defined in skills/)
Skill | One-liner | Since |
Conversational walk-through to configure a connection profile. | v0.2.0 | |
Switch the active profile (no host / user / password re-entry); single-profile users get a friendly bow-out. | v0.4.0 | |
Profile a column: cardinality / top-N / null rate / min-max / existing comment, one round. | v0.3.0 | |
Three-step interactive wizard (schema → table → column) — pick by reading comments. | v0.3.0 | |
Mine | v0.3.0 | |
Cross-table column search by keyword across one or all schemas via schema-wide MCP call. | v0.4.0 | |
Cross-schema table search by keyword across all schemas via cluster-wide MCP call. | v0.4.0 |
Each skill has its own tri-lingual README inside its folder (except
/redshift-setup and /redshift-switch-profile, which are setup-style
internals — see SKILL.md directly).
Quick start
The fastest path is the Claude Code plugin.
# 1. Register the marketplace (one-time)
claude plugin marketplace add kouko/redshift-comment-mcp
# 2. Install the plugin (ships DISABLED — opt-in, since it connects to an external service)
claude plugin install redshift-comment-mcp
# 3. Enable it — this is when the connection dialog appears
claude plugin enable redshift-comment-mcpWhen you enable the plugin, Claude Code shows a connection dialog
asking for host / port (default 5439) / user / dbname / password. Every
field is optional, and what you leave blank decides which of three paths
you get. All of them keep the password in an OS keychain, never in chat
or settings.json:
Fill everything — quick single connection. The password field is
sensitive, so it goes to the OS keychain; host / port / user / dbname are saved tosettings.json. That's all you need for one cluster.Fill host / port / user / dbname, leave password blank — borrow a stored profile's password. The server looks for a profile written by
/redshift-setupwhose host, port, user and dbname all match what you typed here, and the connection always goes to the target you typed — a profile only ever lends its password, never its own host or port. If none matches, the connection refuses, naming the target you typed and each existing profile's target, so you can create a matching profile with/redshift-setupor fill in the password yourself. If more than one matches, the connection refuses the same way, naming every tied candidate — the shape a password rotation leaves behind (the old and new profile, still recorded for the same target) — so you can delete or rename the stale one.Leave every field blank — the profile path. The plugin falls back entirely to
/redshift-setup's profile flow./redshift-setupis the conversational walk-through that writes a named profile (config.toml + active-profile pointer + keychain), and it's also the path for running more than one cluster.
# In a Claude Code chat — the profile path (also the multi-cluster path)
/redshift-setup/redshift-setup walks you through host / port / user / dbname /
password. The password is collected in a system dialog (macOS) or a
zenity prompt (Linux desktop) or your own terminal (headless) — never
in chat. It lands directly in your OS keychain.
After connecting, just type any of the slash commands above.
Multi-cluster? Add a second profile with /redshift-setup <name>, then
switch between them with /redshift-switch-profile.
For Claude Desktop / other MCP clients / local development, scroll down to Other install paths.
Other install paths
Two packaged artifacts — install ONE of them:
Claude Code plugin — gives the 6 slash-command skills plus the MCP server, configured via
/redshift-setup. This is the Quick start above and the recommended path for Claude Code users..mcpbDesktop Extension — gives the MCP server plus a GUI config form in Claude Desktop, but NOT the skills. This is the path for Claude Desktop users who want a one-click install and a connection form instead of editingclaude_desktop_config.jsonby hand.
Scenario | How |
Claude Code (recommended) |
|
Claude Desktop (one-click) | Download the |
Claude Desktop / generic MCP client (manual) |
|
Local development |
|
Multi-cluster |
|
.mcpb prerequisite — uv. The Desktop Extension runs on the uv
runtime, so uv must be available on your machine before you install the
.mcpb (e.g. brew install uv on macOS). The Claude Code plugin path
does not need this step — Claude Code provides its own uv.
The plugin runs from the cloned repo source via
uv run --project ${CLAUDE_PLUGIN_ROOT} — PyPI release is NOT a
prerequisite for plugin updates.
Setting up with uvx — Claude Desktop / generic MCP client
The Claude Code plugin's uv run --project ${CLAUDE_PLUGIN_ROOT} form
is specific to Claude Code. For any other MCP client (Claude Desktop,
generic stdio MCP clients), the equivalent launch is
uvx redshift-comment-mcp against the PyPI release.
Step 1 — set up a profile via the CLI. redshift-comment-mcp
ships the same Q&A flow that the Claude Code plugin's /redshift-setup
uses, exposed as subcommands:
# interactive Q&A — writes config.toml + stores password in OS keychain
uvx redshift-comment-mcp setup
# or a named profile (for multi-cluster setups)
uvx redshift-comment-mcp setup --profile prod
# verify
uvx redshift-comment-mcp test-connection --profile prod
uvx redshift-comment-mcp list-profilesThe files it writes — ~/.config/redshift-comment-mcp/config.toml +
OS keychain entry under service redshift-comment-mcp — are per-user,
not per-client. Run setup once and every MCP client that launches
uvx redshift-comment-mcp afterwards reads the same profile data. If
you already have Claude Code with the plugin, /redshift-setup writes
the exact same files; no duplicate setup needed.
Other useful subcommands: set-password, delete-profile. See
uvx redshift-comment-mcp --help.
For code-agent bootstrap (any MCP client, since v0.7.0): the
preferred path is the in-band MCP tool setup_via_dialog — no Bash
tool, no MCP client restart, password stays out of chat:
agent calls any DB tool → {"error": "not_configured", "next_step": "Call setup_via_dialog..."}
agent asks user for host/user/dbname (these are NOT secrets)
agent calls MCP tool setup_via_dialog(host=..., user=..., dbname=...)
→ server-side spawns OS dialog (macOS osascript / Linux zenity)
→ user types password directly into dialog
→ server writes config.toml + keychain
→ {"status": "configured", ...}
agent retries the DB tool → works (lazy resolve; no restart needed)The server boots in degraded mode even when no profile exists —
DB tools return a structured not_configured error pointing at
setup_via_dialog, so the agent sees the recovery path in its own
tool-call result (no need to read MCP client log files). After setup,
lazy resolution picks up the new profile on the next tool call.
Fallback for headless / non-GUI hosts (no osascript / no
zenity): drop to the Bash + CLI path which uses --stdin instead of
the dialog:
uvx redshift-comment-mcp set-fields --profile default \
--host H --port P --user U --dbname D
echo "$PASSWORD" | uvx redshift-comment-mcp set-password \
--profile default --stdinStep 2 — single profile. In claude_desktop_config.json (or your
client's equivalent):
{
"mcpServers": {
"redshift-comment": {
"command": "uvx",
"args": ["redshift-comment-mcp"]
}
}
}The server resolves which profile to use via this chain (most explicit
wins): --profile CLI flag > REDSHIFT_COMMENT_PROFILE env var >
active-profile pointer file > implicit fallback (lone profile rescue
/ default).
Step 3 — multi-cluster. One MCP server entry per profile, override
the pointer file via --profile:
{
"mcpServers": {
"redshift-prod": {
"command": "uvx",
"args": ["redshift-comment-mcp", "--profile", "prod"]
},
"redshift-stg": {
"command": "uvx",
"args": ["redshift-comment-mcp", "--profile", "stg"]
}
}
}Each entry runs as a separate MCP server; tools appear in the client under their respective server names.
Tip — uv tool install for faster startup. uvx fetches and
spawns on every invocation (~2s after the first cache warmup). If
you'd rather pay the install cost once:
uv tool install redshift-comment-mcpthen point "command" at redshift-comment-mcp directly with no
uvx wrapper.
Where things live
.
├── README.md / README.ja.md / README.zh-TW.md (this file, tri-lingual)
├── implementation_guide.md design rationale + charter
├── src/redshift_comment_mcp/ MCP server source — see its own README
├── skills/ 5 slash-command skills — see its own README
├── commands/ plugin slash command stubs
├── tests/ pytest suite
├── pyproject.toml packaging metadata
└── .claude-plugin/ plugin manifest + marketplaceThe two READMEs to read next:
skills/README.md— overview of all 5 skillssrc/redshift_comment_mcp/README.md— server internals, module map, charter constraints
Data layout at runtime
Path | Contents | Permissions |
| Non-secret profile fields |
|
| One-line pointer to the active profile name. Absent ↔ server uses |
|
| Empty lock file, POSIX only — where |
|
OS keychain ( | Passwords | OS-managed |
config.toml is machine-managed — read this before hand-editing it
config.toml is written only by this project's own tools: the
setup / set-fields / delete-profile subcommands, the
/redshift-setup skill, and the setup_via_dialog MCP tool.
(set-password and /redshift-switch-profile don't touch it — they write
the OS keychain and the active-profile pointer respectively.) Every one
of those writers rewrites the whole file from the profiles it just read,
so anything the project doesn't recognise — your comments, your
blank-line grouping, extra keys — is dropped on the next write. That's the designed behaviour, not a bug:
the file is a store this project owns, not a config file meant to be
authored by hand.
Hand-editing still works (it's plain TOML, and the schema below is stable) — just expect only the recognised keys to survive, and keep anything you'd want to remember somewhere else. A write of one profile never disturbs another profile's fields.
[profile.prod]
host = "my-cluster.abc123.us-east-1.redshift.amazonaws.com"
port = 5439
user = "alice"
dbname = "analytics"Recommended DB GRANTs (defense-in-depth)
execute_sql blocks DDL / DML / admin keywords at the parser layer
(DROP / DELETE / UPDATE / INSERT / ALTER / CREATE /
TRUNCATE / MERGE / GRANT / REVOKE / COPY / UNLOAD), but
that's a layer-1 defense. The defense-in-depth move is to give the
plugin's connecting Redshift user read-only privileges only, so
even if a parser bypass is found, the database itself rejects writes:
-- Create a dedicated read-only user for the plugin
CREATE USER redshift_mcp_reader WITH PASSWORD '...';
-- Grant only what the plugin actually needs
GRANT USAGE ON SCHEMA public, dbt_marts, dbt_staging TO redshift_mcp_reader;
GRANT SELECT ON ALL TABLES IN SCHEMA public, dbt_marts, dbt_staging TO redshift_mcp_reader;
ALTER DEFAULT PRIVILEGES IN SCHEMA public, dbt_marts, dbt_staging
GRANT SELECT ON TABLES TO redshift_mcp_reader;
-- Do NOT grant: INSERT / UPDATE / DELETE / TRUNCATE / DROP / CREATE / GRANT / superuserFor /redshift-lineage-from-stl, the user additionally needs
SYSLOG ACCESS UNRESTRICTED (or admin) to read STL_QUERY /
SYS_QUERY_HISTORY. If you're not running that skill, skip this grant.
Known limits
MCP response token cap (~25K tokens default) — Claude Code silently
truncates MCP tool results above ~25,000 tokens (no error, no marker;
see anthropics/claude-code#2638).
For dbt-rich schemas where column comments are long markdown blocks, a
single list_columns(include_comments=True) page (50 rows) on a wide
table can approach this. Two mitigations the plugin already applies:
include_commentsdefaults to False onlist_tables/list_columns(onlylist_schemasdefaults True since schema count is small) — agent must opt in to comment-loaded responses.MAX_COMMENT_LEN=1000caps each comment in multi-item responses (withcomment_truncated_count+ ellipsis marker). Single-item getters (get_table_comment/get_column_comment) never truncate.
If you still need to bump the cap (e.g. to fetch a heavily-documented
column set in one shot), set MAX_MCP_OUTPUT_TOKENS=50000 in the
environment where Claude Code runs. This affects all MCP servers in
that session, not just this one.
Comment-writing tips for your DB
The plugin shines brightest on tables whose owners invest in comments. Concrete tips (Chinese examples — adapt to your team's language):
COMMENT ON SCHEMA sales IS '[用途] 線上零售銷售數據 [主要實體] 訂單, 客戶, 產品';
COMMENT ON TABLE sales.orders IS '[實體] 訂單 [PK] order_id [FK] customer_id → customers.customer_id';
COMMENT ON COLUMN sales.orders.revenue IS '[定義] 訂單總銷售額 [語意類型] Metric [單位] 新台幣 [計算] 未稅商品總價 + 稅 − 折扣';A more thorough Semantic Layer guide is in
implementation_guide.md Appendix A.
Development
pytest tests/ # run unit + invariant tests (fast, no live cluster)
REDSHIFT_INTEGRATION=1 \
pytest tests/integration/ # opt-in: smoke-test against the active Redshift profile
python -m build # build sdist + wheelThe tests/integration/ smoke gate exercises every MCP tool against a real
Redshift cluster — connection, list / search / get tools, pagination, the
SQL-safety guard. It skips cleanly when REDSHIFT_INTEGRATION is unset, when
no active profile is configured, or when the keychain entry is missing, so
default pytest tests/ is safe in CI.
CI / release flow lives in .github/.
License
Contributing
Issues and pull requests welcome. New skills should follow the
patterns documented in skills/README.md:
read-only, MCP-composed, no direct DB connections, no synthesis
layer. SKILL.md ≤ 130 lines, tri-lingual README, audited via
dev-workflow:skill-judge before commit.
Available Tools
13 toolsexecute_sqlExecute SqlA
Execute a read-only SQL query (SELECT/WITH only). Result rows are paginated via limit/offset.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| sql_statement | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Because annotations are absent, the description carries the behavioral disclosure burden. It states that the operation is read-only, restricts statements to SELECT/WITH, and notes that results are paginated via limit/offset. It does not cover error behavior or statement-size limits, but the core behavioral traits are disclosed.
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 with no filler: the first front-loads the core purpose and restriction, and the second states the pagination behavior. Every clause adds useful 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?
For a single-query tool with an output schema, the description covers purpose, allowed SQL, and pagination. The main gap is lack of explicit guidance on parameter edge cases and error behavior, but these are minor given the simple parameter set and existing output schema.
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 adds meaning by defining sql_statement as a read-only SELECT/WITH query and explaining that limit/offset control pagination. This is more than the raw schema types provide, though it does not detail edge cases like null limits.
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 and resource: 'Execute a read-only SQL query (SELECT/WITH only).' This clearly distinguishes it from the sibling metadata and setup tools, which are about listing, searching, and managing schemas and tables.
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 scope is explicit: only SELECT/WITH queries are allowed, so the agent knows this tool is for read-only querying, not DDL/DML. It does not explicitly name sibling alternatives like list_tables, but the exclusion of writes provides clear enough context for choosing this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_all_column_commentsGet All Column CommentsB
Get authoritative comments for ALL columns in a table at once. Each comment overrides the column name.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| table_name | Yes | ||
| schema_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
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. 'Get' implies a read operation, and 'Each comment overrides the column name' adds useful behavioral context, but pagination behavior, limit/offset effects, and output details are not disclosed.
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 concise and front-loaded with the main action. The second sentence adds behavioral context, though 'overrides' is terse and could be more explicit.
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 documentation is not the description's responsibility. However, with no annotations, no usage guidance, and no parameter semantics, the definition is only minimally complete for a tool with four parameters.
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%, and the description does not mention schema_name, table_name, limit, or offset. With no parameter descriptions in the schema and no compensation in the description, the agent receives no added semantic meaning for the parameters.
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 clearly states the verb ('Get'), resource ('authoritative comments'), and scope ('ALL columns in a table at once'). It distinguishes from the singular get_column_comment sibling by emphasizing the bulk nature, though it does not explicitly name the alternative.
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 phrase 'ALL columns in a table at once' implies this is for bulk retrieval rather than fetching a single column comment, but no explicit when-to-use or when-not-to-use guidance is given. Sibling tools like get_column_comment are not referenced, leaving the agent to infer the tradeoff.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_column_commentGet Column CommentA
Get the authoritative comment for a column — defines its business meaning and calculation logic; trust it over the column name.
| Name | Required | Description | Default |
|---|---|---|---|
| table_name | Yes | ||
| column_name | Yes | ||
| schema_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
There are no annotations, so the description must carry the burden. It adds the useful trait that the returned comment is authoritative and should be preferred over the column name, but it does not disclose behaviors such as whether a missing comment returns null or throws, or whether permissions are needed. Given the output schema exists, this is acceptable but not fully transparent.
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 entire description is one front-loaded sentence that earns its place: it states the action, the resource, and the reason to trust the result. No filler or repetition.
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?
For a simple three-parameter getter with an output schema, the description gives the essential context: the comment is authoritative and business-meaningful. It does not address edge cases like absent comments, but the output schema covers the return shape and the operation is straightforward.
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 needed to compensate, but it only mentions 'column' and never explains schema_name or table_name. The parameter names are self-explanatory, but the definition provides no additional semantic detail about any of the three required parameters.
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?
Description opens with 'Get the authoritative comment for a column', a specific verb-resource pairing that clearly states what the tool does. The added note that the comment defines business meaning and calculation logic distinguishes it from generic column metadata and from sibling comment tools like get_table_comment.
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?
It tells the agent when to rely on this tool: when the authoritative business meaning or calculation logic of a column is needed, and to trust it over the column name. It does not explicitly contrast with get_table_comment or get_all_column_comments, but the column-specific scope and 'trust it' guidance provide clear context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_schema_commentGet Schema CommentA
Get the authoritative comment for a schema — defines its true business purpose; trust it over the schema name.
| Name | Required | Description | Default |
|---|---|---|---|
| schema_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It discloses that the returned comment is authoritative and should be trusted over the schema name, a genuine behavioral trait beyond the tool name. The verb 'Get' also communicates a read-only operation, though it doesn't address edge cases like missing comments.
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 a single, efficient sentence that front-loads the core purpose and then adds a useful distinguishing note. There is no filler, and every phrase earns its place.
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?
For a simple getter with a single parameter and an output schema, the description provides sufficient business context and behavioral guidance. It doesn't cover error scenarios or absent-comment behavior, but those are likely defined by the output schema and are not critical for a basic retrieval 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 description coverage is 0%, so the description must compensate for the parameter 'schema_name', but it adds little beyond the word 'schema'. It does not clarify formats, case sensitivity, or what identifiers are valid, leaving the parameter largely to inference from its name.
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 ('Get') and resource ('authoritative comment for a schema'), and adds meaningful context by explaining the comment defines the schema's true business purpose. This clearly distinguishes it from siblings like get_table_comment and get_column_comment, which target different objects.
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 clearly implies this tool is for schema-level comments and even advises trusting it over the schema name, which gives context on when to use it. However, it does not explicitly mention alternatives or exclusion conditions, so it stops short of fully naming when-not-to-use or sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_setup_statusGet Setup StatusA
Read-only check of whether a profile is configured. Safe to call at any time including the very start of a session — does not touch Redshift, does not return any secrets.
Use at session start to decide proactively whether to call
setup_via_dialog (before triggering any DB tool's
not_configured error path), or to verify a setup_via_dialog
call succeeded from a fresh angle.
profile overrides which profile to check in profile mode,
exactly like the CLI --profile flag — both go through
config.resolve_active_profile with the same priority. Omit
it (the default) to see the profile the server would actually
resolve to right now: REDSHIFT_COMMENT_PROFILE env var, then
the active-profile pointer file, then the upgrade-rescue
lone-profile fallback, before the literal "default". It has
no effect in inline / borrowed mode, where connection resolution
never consults a profile name at all.
Returns:
profile— in profile mode, the profile actually resolved (which may differ from what you passed, or from the literal "default", per the resolution above);Nonein inline / borrowed mode. No profile is that mode's connection target, so the field never names one — echoing back the call argument (or the literal "default") would tell you the connection is on a profile that may not even exist. In "borrowed" mode specifically, the lending profile's name is reported separately inborrowed_from_profile; the connection itself still never targets that profile, only borrows its passwordsource— the mechanism actually in force:"inline"(launch-arg host/user/dbname, password from theREDSHIFT_PASSWORDenv var or none),"borrowed"(launch-arg host/port/user/dbname, no inline password, but a stored profile whose host, port, user AND dbname all match lent its keychain password — the connection target is still the INLINE values, never the matched profile's), or"profile"(config.toml + keychain, no launch args)configured— bool, equivalent to has_fields && has_passwordhas_fields— whether the connection target (host / port / user / dbname) is known; in inline / borrowed mode, always True (the fields came from launch args); in profile mode, False only when the resolved profile has no config.toml entryhas_password— whether a password is available (OS keychain in profile / borrowed mode; theREDSHIFT_PASSWORDenv var in plain inline mode). NEVER returns the password itselfhost/port/user/dbname— the target the connection will actually use, present only when has_fields=True (these are non-secret)borrowed_from_profile— present only when source="borrowed": the name of the profile whose keychain password was borrowednext_step— present only when configured=False; actionable hint pointing at the right mechanism for the mode
| Name | Required | Description | Default |
|---|---|---|---|
| profile | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It discloses safety ('does not touch Redshift, does not return any secrets'), time-independence ('Safe to call at any time'), resolution precedence for profiles, and mode-specific behaviors (inline/borrowed/profile). This is far beyond what annotations would typically cover.
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 long (~600 words), but every section (purpose, safety, usage, parameter semantics, return fields) adds unique value given the tool's multi-mode behavior. It is front-loaded with the core purpose and safety statement. While not terse, it avoids fluff and remains well-structured with clear field explanations.
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 description fully explains each return field, its conditions (e.g., 'present only when has_fields=True'), the meaning of 'borrowed_from_profile', and how 'next_step' is actionable. The output schema likely lists fields, but the description adds the conditional logic and mode semantics that an agent needs to interpret results correctly. Nothing important is missing for a tool of this complexity.
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 input schema shows only a single nullable 'profile' parameter with no description (schema coverage 0%). The description compensates thoroughly by explaining what the parameter overrides, the exact resolution order (env var, pointer file, fallback, literal 'default'), when it has no effect, and how its output differs from the input — including a nuanced explanation of why the returned profile may differ from the passed argument.
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 first sentence states a specific verb and resource: 'Read-only check of whether a profile is configured.' It also immediately disambiguates from siblings by noting it does not touch Redshift and is safe to call at any time, clearly separating it from setup_via_dialog and other DB-bound tools.
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 explicitly says 'Use at session start to decide proactively whether to call setup_via_dialog (before triggering any DB tool's not_configured error path), or to verify a setup_via_dialog call succeeded from a fresh angle.' This gives concrete when-to-use guidance and names the alternative tool, leaving no ambiguity about the context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_table_commentGet Table CommentB
Get the authoritative comment for a table — defines what data it actually contains; trust it over the table name.
| Name | Required | Description | Default |
|---|---|---|---|
| table_name | Yes | ||
| schema_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral disclosure burden. It communicates that the result is authoritative and should be trusted over the table name, which is useful behavioral context. It does not address potential empty comments, error conditions, or permissions, but the output schema covers return structure.
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 that states the operation and adds a meaningful directive ('trust it over the table name'). No filler or repetitive material.
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?
For a simple two-parameter read tool with an output schema, the description is nearly sufficient. The main missing pieces are explicit parameter semantics and guidance on alternatives, which keeps it from being fully complete for an agent deciding among the comment and search siblings.
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% and the description does not explain schema_name or table_name beyond what their property names already imply. Since the description was expected to compensate for the missing schema descriptions, this is a gap even though the parameter names are self-explanatory.
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 action and resource ('Get ... comment for a table') and adds meaning by calling the comment 'authoritative' and contrasting it with the table name. It does not explicitly differentiate from sibling comment tools like get_column_comment or get_schema_comment, though the table focus is implied by the name.
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?
It implies when to use the tool: when you need the actual meaning of a table rather than guessing from its name ('defines what data it actually contains; trust it over the table name'). No explicit exclusions or comparisons to alternatives such as get_all_column_comments or get_schema_comment are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_columnsList ColumnsB
List columns (name, type, nullable) in a table. Pass include_comments=True to include column comments inline; include_parent_comments (default True) also returns the parent table's comment.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| table_name | Yes | ||
| schema_name | Yes | ||
| include_comments | No | ||
| include_parent_comments | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral disclosure burden. 'List' clearly indicates a read-only operation, and it explains the conditional inclusion of column and parent-table comments. However, it does not mention pagination behavior or any side effects, so the disclosure is adequate but not rich.
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 sentences with no filler; the main list behavior is front-loaded and the optional comment behaviors are stated compactly. Every sentence earns its place.
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 description covers the core invocation and the non-obvious comment options, and an output schema exists to define return values. It doesn't position the tool against its siblings or mention how limit/offset apply, which leaves some context gaps for an agent deciding among list_tables/search_columns.
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?
With 0% schema description coverage, the description must compensate for the schema, and it does add useful semantics for include_comments and include_parent_comments. It leaves limit, offset, schema_name, and table_name to convention, which is mostly acceptable for obvious names but still leaves the low-coverage burden only partially discharged.
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 and resource ('List columns in a table') and names the returned fields, making the core purpose unmistakable. It doesn't explicitly contrast with search_columns or get_all_column_comments, so it stops short of full sibling differentiation.
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 choose this tool over search_columns, get_all_column_comments, or list_tables. The description only says what it does and how to turn on comments, which implies the read/list use case but never states exclusions or alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_schemasList SchemasB
List schema names. include_comments defaults to True (cheap — schema count is small).
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| include_comments | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description itself provides a cost/behavior note: include_comments defaults to True and is cheap because the schema count is small. It does not disclose pagination behavior or ordering, but for a read-only list operation the main behavioral risk is minimal.
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 with the core action front-loaded and no filler. The second sentence earns its place by explaining a default's cost implication.
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 output schema covers return values, but the description is incomplete for an agent deciding between list and search, and it omits pagination parameter semantics. Default no-arg usage is clear, but the full tool surface is not adequately explained.
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 explain the parameters. It only addresses include_comments (default and cost); limit and offset are left entirely undocumented.
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 says 'List schema names,' which names a specific action and resource. It is not as explicit as naming the sibling search_schemas, but the verb and object make the primary purpose clear.
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?
No guidance is given about when to choose list_schemas over search_schemas or list_tables/list_columns. The only contextual note is about include_comments being cheap, which addresses a parameter rather than tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_tablesList TablesB
List tables in a schema. Pass include_comments=True to include table comments inline; include_parent_comments (default True) also returns the parent schema's comment.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| schema_name | Yes | ||
| include_comments | No | ||
| include_parent_comments | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden of behavioral disclosure. It clarifies the effect of include_comments and include_parent_comments, which adds value, but it omits other relevant behaviors such as pagination (limit/offset) or error handling (e.g., missing schema). For a read-only listing tool, this level of transparency is adequate but not thorough.
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 concise, front-loaded sentences communicate the primary purpose and the two most nuanced parameters. There is no redundant language or repetition of the title. Every sentence contributes meaning.
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?
For a tool with five parameters and zero schema description coverage, the description is incomplete. It fails to mention pagination parameters (limit/offset) or the required schema_name, leaving the agent to infer them from the input schema alone. The existence of an output schema mitigates the need to describe return values, but the missing parameter explanations severely limit contextual completeness.
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 for all five parameters. It explains include_comments and include_parent_comments but says nothing about limit, offset, or schema_name. schema_name is implied as the required input, but limit and offset remain undocumented. This is a significant gap given the lack of schema-level descriptions.
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 clear verb and resource: 'List tables in a schema.' It goes beyond the title by specifying the optional comment-inclusion behavior, making the tool's purpose unambiguous. While it doesn't explicitly compare itself to sibling tools like list_columns or search_tables, the wording is distinct enough for an agent to infer that this enumerates tables within a given schema.
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?
No guidance is given on when to choose this tool over alternatives such as search_tables or list_columns. The description focuses on parameter effects (include_comments) but lacks any context about typical use cases or exclusions. An agent seeing only this would not know whether to pick list_tables or search_tables for a given request.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_columnsSearch ColumnsA
Search columns by keywords (space-separated, OR logic) over column name and comment.
schema_name is required. Pass table_name to scope to one table (cheap; use this for routine drill-down). Omit table_name to search every table in the schema (schema-wide; the natural primitive for cross-table FK / JOIN-key reconnaissance, returns table_name on each row).
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| keywords | Yes | ||
| table_name | No | ||
| schema_name | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are present, so the description carries the full burden. It discloses the search logic (space-separated OR), scoping behavior, and return field when table_name is omitted. However, it does not explicitly state that the operation is read-only or non-destructive, nor does it mention ordering or pagination behavior. The disclosed traits are useful and accurate, but the absence of an explicit read-only statement leaves a minor gap.
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 two sentences, front-loaded with the primary purpose, and packs essential usage guidance without fluff. Every clause adds value, from OR logic to the table_name scoping trade-off. It is a model of efficient, high-info documentation.
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 the output schema exists (which likely documents return format), the description covers the main usage patterns and return behavior. However, the missing limit/offset semantics is a notable gap for a schema-wide search that could return many rows. There is also no mention of result ordering or potential size limits, so the agent may not know how to handle large result sets. Overall, it is solid but not fully exhaustive.
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 explain all parameters. It explains keywords, schema_name (required), and table_name (optional with usage details), but does not mention limit or offset at all. These pagination parameters are left undocumented, forcing the agent to guess their semantics. The explanation covers the core parameters but is incomplete for a 5-parameter tool.
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 ('Search'), a resource ('columns'), and the search scope ('column name and comment'). It clearly distinguishes this from sibling tools like list_columns and search_tables by focusing on keyword-based column search with OR logic. The purpose is unambiguous and actionable.
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 explicitly tells when to use table_name (routine drill-down, cheap) versus omitting it (schema-wide, natural for cross-table FK/JOIN reconnaissance). It provides concrete use cases and even notes the return behavior for the schema-wide mode. This is strong guidance that helps the agent choose the right call without extra reasoning.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_schemasSearch SchemasA
Search schemas by keywords (space-separated, OR logic) over schema name and comment.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| keywords | Yes |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden of behavioral disclosure. It usefully reveals that keywords are space-separated, use OR logic, and match against schema name and comment. It does not mention ordering, case sensitivity, or side effects, though 'search' implies a read-only operation.
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 a single sentence with no filler. The verb, target, and key behavioral detail (OR logic, searched fields) are front-loaded and directly useful to an agent.
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 structure is covered elsewhere. The description is adequate for a simple search tool but lacks guidance on when to choose search_schemas over list_schemas, and it leaves limit/offset semantics unspecified. It is minimally viable but not rich.
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 adds important semantics for the required 'keywords' parameter: space-separated terms with OR logic over name and comment. However, it does not explain 'limit' or 'offset,' which are left to inference from their names and defaults.
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 ('Search'), a specific resource ('schemas'), and a precise scope ('over schema name and comment'). This clearly differentiates it from sibling tools like list_schemas, search_tables, and search_columns.
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 the tool: when you need to find schemas by keyword. However, it does not explicitly contrast it with list_schemas or search_tables/search_columns, nor does it state when not to use it or which alternative to prefer.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_tablesSearch TablesA
Search tables by keywords (space-separated, OR logic) over table name and comment.
Pass schema_name to scope to one schema (faster, narrower). Omit it to search across all user schemas in the cluster (broader, slightly slower).
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| keywords | Yes | ||
| schema_name | No |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral burden and discloses useful traits: OR logic for space-separated terms, match fields, schema-scoping behavior, and the breadth/speed tradeoff. It doesn't discuss pagination or other edge behaviors, but an output schema exists and the core behavior is transparent.
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 compact sentences front-load the core behavior and then explain the optional scoping parameter. There is no filler, repeated schema content, or extraneous detail.
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?
For a four-parameter search with an output schema, the description covers the search semantics, keyword logic, and scoping options well. It lacks sibling-alternative routing and pagination phrasing, but these are minor given the output schema and self-explanatory limit/offset parameters.
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 add meaning. It does define keywords and schema_name well, but limit and offset receive no explanation beyond their names, which is only partially sufficient for a tool with no parameter descriptions.
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 opens with a precise verb-resource pair—'Search tables'—and specifies exactly what is matched: table name and comment using space-separated OR keywords. This makes the operation unambiguous and distinguishes it from sibling tools like search_columns or search_schemas without needing to inspect their schemas.
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?
It gives concrete guidance on the schema_name parameter: pass it to scope and speed up the search, omit it to cover all user schemas. It does not explicitly name alternative tools or state when not to use this tool, so it stops short of full exclusion guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
setup_via_dialogSetup Via DialogA
Bootstrap (or update) a Redshift connection profile from inside an MCP session.
Use when DB tools (list_schemas etc.) return {"error": "not_configured"},
or to add a new profile / re-key an existing one. Ask the user for
host / port / user / dbname conversationally — these are not secret —
then call this tool. The password is collected via an OS-native
dialog (macOS osascript / Linux zenity) launched server-side; it
never crosses the MCP wire, never appears in chat or tool args.
Outcomes (return shape):
{"status": "configured", ...}— profile written, password in keychain. Lazy resolve picks it up on next DB tool call; no restart needed.{"status": "dialog_cancelled" | "permission_denied" | "dialog_unavailable" | "platform_unsupported" | "empty_password", ...}— the password step failed, so NOTHING was written: config.toml and the keychain are exactly as they were before the call. The message field tells the agent / user what to do next (often: runredshift-comment-mcp set-fields+set-password --profile X --stdinfrom a terminal).
Write ordering: the password is collected FIRST; config.toml and the keychain are only touched once one is in hand. That keeps a failed setup from leaving a profile whose fields point at the new cluster while the keychain still holds the old password.
For headless environments without a GUI, prefer the CLI pair
set-fields + set-password --stdin instead.
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | ||
| port | No | ||
| user | Yes | ||
| dbname | Yes | ||
| profile | No | default |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full behavioral disclosure. It explains that the password never crosses the wire, uses OS-native dialogs, defines outcome statuses, and details write ordering (password first, then config/keychain). It also clarifies that on failure nothing is written, which is crucial for an agent's decision-making.
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 structured with clear sections: trigger, procedure, outcomes, write ordering, and alternative. It front-loads purpose and usage, then adds necessary detail. Every sentence serves a purpose—no fluff. Despite its length, it is efficient and well-organized.
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 the tool's complexity (dialog, password handling, keychain, multiple failure modes, headless alternative), the description is thorough. It covers all outcomes, side effects, and prerequisites. The output schema exists, but the description still explains return statuses and failure implications, making it complete for an agent to use 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?
Schema coverage is 0%, so the description must compensate. It explains that host/port/user/dbname are collected conversationally and are non-secret, and mentions profile concept. It does not detail each parameter's format or constraints, but the schema already provides types and defaults. The description adds meaningful context beyond the raw schema, though it could be more specific about the profile parameter.
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 clearly states the tool's purpose: to bootstrap or update a Redshift connection profile. It specifies the exact trigger condition (DB tools returning not_configured) and distinguishes itself from sibling query tools by focusing on setup. It's not a tautology and adds actionable context.
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?
It explicitly states when to use the tool: when DB tools return not_configured, or to add/re-key a profile. It also gives a clear alternative for headless environments (CLI pair set-fields + set-password). The guidance is direct and leaves no ambiguity about when to use this tool vs alternatives.
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.
1 tool update
v0.12.0- Changed
get_setup_status3 fields changed- added
Input schema / properties / profile / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / profile / defaultPrevious value: -"default"New value: +null - removed
Input schema / properties / profile / typeRemoved value: -"string"
13 tool updates
v0.1.0- First observed
execute_sql - First observed
get_all_column_comments - First observed
get_column_comment - First observed
get_schema_comment - First observed
get_setup_status - First observed
get_table_comment - First observed
list_columns - First observed
list_schemas - First observed
list_tables - First observed
search_columns - First observed
search_schemas - First observed
search_tables - First observed
setup_via_dialog
TDQS
Scored across 13 tools
Most tools are cleanly separated by resource and action (list/search/get on schemas/tables/columns), and execute_sql/setup_via_dialog are unambiguous. Some overlap remains: list_tables/list_columns with include_comments can partially substitute for get_table_comment/get_all_column_comments, and the 'authoritative' distinction is a bit subtle.
Tool names consistently follow a verb_noun snake_case pattern: list_*, search_*, get_*, execute_sql, setup_via_dialog. Resource nouns are regular across list/search tools, and comment getters follow object+_comment. No mixed conventions or vague verb choices.
13 tools is within the ideal range and covers discovery, search, comment retrieval, SQL, and setup. A few comment getters are arguably redundant with the include_comments options on list tools, but the count is still well-scoped for the domain.
The surface covers schema/table/column discovery, comment lookup, keyword search, ad-hoc SQL, and bootstrap/status, so core workflows have no dead ends. Minor gaps remain: there is no bulk table-comment fetch independent of listing, and column search requires a schema rather than supporting a true cluster-wide search.
Maintenance
Related MCP Connectors
Query your org's data in natural language — read-only MCP access to SQL, NoSQL, files & warehouses.
Query your warehouse or a CSV with Claude/ChatGPT over MCP, governed by table-level ACL + audit.
Draxlr's remote MCP server connects AI assistants to your SQL databases and dashboards. Explore schemas, run read-only queries, manage saved queries and dashboards, and export results, all with row-level security so each user sees only their own data.
An MCP server that provides read access to your cloud storage providers, bank accounts and more.
Related MCP Servers
- AlicenseBqualityDmaintenanceA Model Context Protocol server that enables AI assistants to interact with Amazon Redshift databases, allowing for schema exploration, query execution, and statistics collection.32Apache 2.0
- AlicenseAqualityCmaintenance🤖 Enable AI assistants (Claude, Cursor) to monitor, diagnose, and query Amazon Redshift using this MCP server and the AWS Data API.76MIT
- AlicenseCqualityDmaintenanceA read-only MCP server that enables users to query Databricks SQL, browse metadata, and monitor Delta Lake tables. It also supports tracking Databricks Jobs, DLT Pipelines, and cluster metrics through natural language interfaces.254MIT
- AlicenseAqualityDmaintenanceA read-only MCP server for exploring and analyzing a Secoda data catalog, enabling AI chat, semantic search, glossary browsing, and data lineage tracing.12Apache 2.0