Skip to content

docs(mcp): document deleted_state trash listing for list_charts/list_dashboards - #44128

Merged
aminghadersohi merged 4 commits into
masterfrom
docs/pr-41855-needs-docs-feat-mcp-deleted-state-trash-
Sep 24, 2026
Merged

aminghadersohi merged 4 commits into
masterfrom
docs/pr-41855-needs-docs-feat-mcp-deleted-state-trash-

Conversation

@rusackas

Copy link
Copy Markdown
Member

SUMMARY

#41855 added a deleted_state parameter to the list_charts and list_dashboards MCP tools for listing soft-deleted (trashed) objects, but the MCP server docs never mentioned it. This adds a section documenting the parameter's values, the deleted_at field it surfaces, and the restore-audience visibility scoping (owner or admin) it inherits from the REST filters it reuses.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A (docs only)

TESTING INSTRUCTIONS

Read the new "Trash Listing (Soft-Deleted Objects)" section in docs/admin_docs/configuration/mcp-server.mdx.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

Follow-up docs for #41855.

🤖 Generated with Claude Code

@bito-code-review

bito-code-review Bot commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Code Review Agent Run #b1db25

Actionable Suggestions - 0
Filtered by Review Rules

Bito filtered these suggestions based on rules created automatically for your feedback. Manage rules.

  • docs/admin_docs/configuration/mcp-server.mdx - 1
Review Details
  • Files reviewed - 1 · Commit Range: 476a113..476a113
    • docs/admin_docs/configuration/mcp-server.mdx
  • Files skipped - 0
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers an incremental AI Review.

  • /review full - Manually triggers a full AI Review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@github-actions github-actions Bot added doc Namespace | Anything related to documentation preset-io labels Sep 10, 2026
@netlify

netlify Bot commented Sep 10, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for superset-docs-preview ready!

Name Link
🔨 Latest commit d9c7535
🔍 Latest deploy log https://app.netlify.com/projects/superset-docs-preview/deploys/6ab3d86bf70cd60008b81370
😎 Deploy Preview https://deploy-preview-44128--superset-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread docs/admin_docs/configuration/mcp-server.mdx Outdated
Comment thread docs/admin_docs/configuration/mcp-server.mdx Outdated
@bito-code-review

bito-code-review Bot commented Sep 11, 2026 •

Copy link
Copy Markdown
Contributor

Code Review Agent Run #6f1e90

Actionable Suggestions - 0
Additional Suggestions - 1
  • docs/admin_docs/configuration/mcp-server.mdx - 1
    • Doc scoping nuance · Line 942-942
      The "can edit" correction is accurate and an improvement over "they own" — `_scope_to_restore_audience` scopes non-admins to `editors.any(...)`. However, the parenthetical "the same audience that can restore them" overstates the equivalence: the filter's own docstring notes it is "deliberately approximate... narrower than the true audience" for `EXTRA_EDITORS_RESOLVER`-granted editorship and guest users. Consider noting this.
Review Details
  • Files reviewed - 1 · Commit Range: 476a113..33beeee
    • docs/admin_docs/configuration/mcp-server.mdx
  • Files skipped - 0
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers an incremental AI Review.

  • /review full - Manually triggers a full AI Review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

Comment thread docs/admin_docs/configuration/mcp-server.mdx Outdated
Comment thread docs/admin_docs/configuration/mcp-server.mdx Outdated
@codecov

codecov Bot commented Sep 16, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.02%. Comparing base (6323b37) to head (d9c7535).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master   #44128       +/-   ##
===========================================
+ Coverage   66.14%   81.02%   +14.87%     
===========================================
  Files        2952     2952               
  Lines      177937   177950       +13     
  Branches    41245    41248        +3     
===========================================
+ Hits       117702   144183    +26481     
+ Misses      57728    31049    -26679     
- Partials     2507     2718      +211     
Flag Coverage Δ
hive 36.84% <ø> (-0.01%) ⬇️
mysql 55.99% <ø> (-0.01%) ⬇️
postgres 56.00% <ø> (-0.02%) ⬇️
presto 38.77% <ø> (-0.01%) ⬇️
python 85.31% <ø> (+28.98%) ⬆️
sqlite 55.72% <ø> (-0.01%) ⬇️
unit 77.59% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bito-code-review

bito-code-review Bot commented Sep 16, 2026 •

Copy link
Copy Markdown
Contributor

Code Review Agent Run #1e31c5

Actionable Suggestions - 0
Review Details
  • Files reviewed - 3 · Commit Range: 33beeee..ec2c539
    • docs/admin_docs/configuration/mcp-server.mdx
    • superset/mcp_service/chart/schemas.py
    • superset/mcp_service/dashboard/schemas.py
  • Files skipped - 0
  • Tools
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers an incremental AI Review.

  • /review full - Manually triggers a full AI Review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@mikebridge mikebridge left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. The request example, deleted_at response guidance, and editor-based trash visibility descriptions match the implementation. The earlier review feedback is addressed, including the generated schema descriptions.

Reviewed ec2c539; CI is green. This was source/contract review, without rerunning integration tests or a live MCP session.

Comment thread docs/admin_docs/configuration/mcp-server.mdx Outdated
@pull-request-size pull-request-size Bot added size/M and removed size/S labels Sep 23, 2026
@bito-code-review

bito-code-review Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Code Review Agent Run #72e905

Actionable Suggestions - 0
Review Details
  • Files reviewed - 3 · Commit Range: ec2c539..c91b722
    • docs/admin_docs/configuration/mcp-server.mdx
    • superset/mcp_service/chart/schemas.py
    • superset/mcp_service/dashboard/schemas.py
  • Files skipped - 0
  • Tools
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers an incremental AI Review.

  • /review full - Manually triggers a full AI Review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

rusackas and others added 4 commits September 23, 2026 06:39
…dashboards

#41855 added a deleted_state parameter to list_charts and list_dashboards for
listing soft-deleted (trashed) objects, but the MCP server docs never
mentioned it.

Co-Authored-By: Evan Rusackas <evan@preset.io>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The deleted_state example passed the arg at the top level, which
list_charts rejects (all params must be wrapped in `request`). Also
corrected the visibility scoping description from "own" to "can edit",
matching the actual restore-audience filter.

Co-Authored-By: Evan Rusackas <evan@preset.io>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ehavior

Reword the trash-listing docs and the list_charts/list_dashboards
deleted_state field descriptions to say the restore audience (editors),
not owners, and to describe unsupported list tools as silently ignoring
deleted_state rather than rejecting it.

Co-Authored-By: Evan Rusackas <evan@preset.io>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…listing scope

The deleted_state visibility filter is narrower than the true restore
audience for editorship granted via EXTRA_EDITORS_RESOLVER or derived
from guest roles, per the filter's own docstring. Call that out in the
doc and the generated ListChartsRequest/ListDashboardsRequest schema
descriptions so callers don't assume trash listing always matches
restore access.

Co-Authored-By: Evan Rusackas <evan@preset.io>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@rusackas
rusackas force-pushed the docs/pr-41855-needs-docs-feat-mcp-deleted-state-trash- branch from c91b722 to d9c7535 Compare September 23, 2026 13:47
@bito-code-review

bito-code-review Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Code Review Agent Run #4b5d78

Actionable Suggestions - 0
Review Details
  • Files reviewed - 3 · Commit Range: 6e5f55f..d9c7535
    • docs/admin_docs/configuration/mcp-server.mdx
    • superset/mcp_service/chart/schemas.py
    • superset/mcp_service/dashboard/schemas.py
  • Files skipped - 0
  • Tools
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers an incremental AI Review.

  • /review full - Manually triggers a full AI Review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@richardfogaca richardfogaca left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Richard's agent here: verified the values, deleted_at behaviour and restore-audience scoping against the filters. LGTM.

Optional

  • Mention the MCP restore_chart / restore_dashboard tools next to the REST endpoint.
  • The "Tool Pagination" example above still passes top-level page=, which the tool rejects.

@aminghadersohi
aminghadersohi merged commit 96d31ee into master Sep 24, 2026
77 checks passed
@aminghadersohi
aminghadersohi deleted the docs/pr-41855-needs-docs-feat-mcp-deleted-state-trash- branch September 24, 2026 22:37
aminghadersohi added a commit to aminghadersohi/superset that referenced this pull request Sep 25, 2026
CI merges master 96d31ee (apache#44128), whose deleted_state descriptions explain edit/restore eligibility and omitted EXTRA_EDITORS_RESOLVER/guest editorship. These are legitimate caller-facing caveats, not redundant schema expansion, so preserve them rather than trim information to fit a stale budget.

Approved b5a91a3 and head 24812ac both serialize list_charts at 4,946 bytes and list_dashboards at 4,419. The docs-only include_schemas example contributes zero bytes. Master's descriptions grow from 333 to 536 bytes (+203) and 342 to 549 (+207), yielding 5,149 and 4,626 in CI's 8273636 merge.

Raise only these limits to 5,300 and 4,800 using the existing ceil(bytes/100)*100+100 policy. Retain complete-schema parity checks; no production field or description changes.

Validation: MCP unit suite: 5,205 passed, 4 skipped on branch; 5,246 passed, 4 skipped on CI merge tree with this fix. Pre-commit passed for all branch-changed files, including mypy.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Namespace | Anything related to documentation preset-io size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants