chore(mcp): update CLAUDE.md to reflect current codebase patterns#39348
chore(mcp): update CLAUDE.md to reflect current codebase patterns#39348aminghadersohi merged 4 commits intoapache:masterfrom
Conversation
|
Bito Automatic Review Skipped - Files Excluded |
✅ Deploy Preview for superset-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates superset/mcp_service/CLAUDE.md to align MCP agent-facing documentation with current MCP service implementation patterns (decorator injection, RBAC, middleware, logging, and testing) after many merged changes since Jan 2025.
Changes:
- Refreshes architecture/module map and explains dependency injection startup flow.
- Replaces stale decorator/auth patterns with current
superset_core.mcp.decorators+ToolAnnotations, RBAC guidance, andevent_loggerinstrumentation. - Updates conventions for middleware, config, flexible input parsing, and async testing via
fastmcp.Client.
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project status has failed because the head coverage (99.81%) is below the target coverage (100.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## master #39348 +/- ##
=======================================
Coverage 64.45% 64.45%
=======================================
Files 2555 2555
Lines 132721 132747 +26
Branches 30802 30810 +8
=======================================
+ Hits 85539 85568 +29
+ Misses 45696 45688 -8
- Partials 1486 1491 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Remove stale references and sync with 90+ merged MCP PRs since Jan 2025: - Remove @parse_request decorator references (removed in apache#38918) - Fix decorator import path: superset_core.mcp.decorators (not api.mcp) - Add ToolAnnotations pattern (required since apache#38641) - Add RBAC permission checking docs (apache#38407) - Add event_logger instrumentation pattern (apache#37859) - Add middleware documentation (apache#38523) - Add compile check pattern for chart creation (apache#38408) - Update auth docs: mcp_auth_hook only for resources, @tool handles tools - Update config section with MCP_RBAC_ENABLED, cache, store configs - Update testing conventions: async Client pattern, conftest fixtures - Update architecture tree with all current modules - Add dependency injection architecture explanation - Remove stale line number references - Fix broken pitfall #9 (identical good/bad examples) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove nonexistent database/ module from architecture tree and test org - Fix caching docs: in-memory by default, Redis only when store enabled - Add missing `from typing import Any` import in type hints example - Use `model_dump()` instead of deprecated `dict()` (Pydantic v2)
Makes the excluded_tools config snippet copy/paste-safe by replacing Python ellipsis literal with a descriptive comment.
38c7629 to
82354d1
Compare
|
🎪 ⚡ showtime-trigger-start |
|
🎪 Showtime deployed environment on GHA for 82354d1 • Environment: http://54.68.169.30:8080 (admin/admin) |
- Replace markdown tables with bullet lists to fix rendering issues - Make @mcp_auth_hook usage more explicit in resource example
|
This is jus a claude.md change. it doesnt change the code. not sure why we need to test the environtment as this is really only for the development cycle. |
|
🎪 Showtime deployed environment on GHA for 9ffb504 • Environment: http://44.248.57.88:8080 (admin/admin) |
|
Bito Automatic Review Skipped – PR Already Merged |
SUMMARY
Updates
superset/mcp_service/CLAUDE.mdto reflect the current state of the MCP codebase after 90+ merged PRs since Jan 2025. This doc is used by LLM agents to understand MCP service conventions.Key changes:
@parse_requestdecorator references (removed in fix(mcp): remove @parse_request decorator for cleaner tool schemas #38918)superset_core.mcp.decorators(was incorrectly documented assuperset_core.api.mcp)ToolAnnotationspattern (required since feat(mcp): Add tool annotations for MCP directory compliance #38641)event_loggerinstrumentation pattern (feat(mcp): add event_logger instrumentation to MCP tools #37859)mcp_auth_hookis only for resources,@toolhandles tool authMCP_RBAC_ENABLED, cache, and store configsClientpattern,conftestfixturesBEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
N/A - documentation only
TESTING INSTRUCTIONS
superset/mcp_service/CLAUDE.mdfrom superset_core.mcp.decorators import tool)@parse_requestorsuperset_core.api.mcpADDITIONAL INFORMATION