Skip to content

[docs-utils] Testing new MCP tool on Dashboard plugin#247774

Merged
clintandrewhall merged 3 commits intoelastic:mainfrom
clintandrewhall:docs/dashboard
Jan 15, 2026
Merged

[docs-utils] Testing new MCP tool on Dashboard plugin#247774
clintandrewhall merged 3 commits intoelastic:mainfrom
clintandrewhall:docs/dashboard

Conversation

@clintandrewhall
Copy link
Copy Markdown
Contributor

@clintandrewhall clintandrewhall commented Jan 4, 2026

Summary

This PR is the result of testing the new MCP tool from #247688 to resolve documentation issues in the Dashboard plugin.

Check the documentation for the dashboard plugin.

[1 tool called]

The documentation check for the **dashboard plugin** (`@kbn/dashboard-plugin`) has **failed** with the following issues:

| Issue Type | Count |
|------------|-------|
| Missing comments | 100 |
| Missing complex type info | 33 |
| Missing returns | 25 |
| Param doc mismatches | 19 |
| Missing exports | 11 |
| Any type usage | 0 |

**Summary:**
- **Total Issues:** 188
- **Actionable:** 177 (issues that can be fixed directly in this plugin)
- **Pending:** 11 (typically `missingExports` that may require changes in consuming packages)

The plugin has 102 documented APIs, but many are missing proper JSDoc comments, return type documentation, or have parameter documentation mismatches.

Would you like me to get the detailed issues with source context and fix templates so you can address them?

cursor_dashboard_plugin_documentation.md

@clintandrewhall clintandrewhall requested a review from a team as a code owner January 4, 2026 19:00
@clintandrewhall clintandrewhall added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting v9.4.0 labels Jan 4, 2026
@clintandrewhall clintandrewhall mentioned this pull request Jan 5, 2026
Draft
13 tasks
@nreese nreese self-requested a review January 6, 2026 15:12
nreese
nreese approved these changes Jan 6, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

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

kibana-presentation changes LGTM. The tool did a remarkable job of describing these types and functions.

src/platform/plugins/shared/dashboard/common/locator/get_dashboard_locator_params.ts
import type { DashboardLocatorParams } from '..';

/**
* Extracts dashboard locator parameters from an embeddable API based on drilldown options.
Copy link
Copy Markdown
Contributor

@nreese nreese Jan 6, 2026

Choose a reason for hiding this comment

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

Nit: this line just duplicates the second line and can be removed.

@clintandrewhall clintandrewhall enabled auto-merge (squash) January 15, 2026 19:18
@clintandrewhall clintandrewhall merged commit ba60184 into elastic:main Jan 15, 2026
13 checks passed
@clintandrewhall clintandrewhall deleted the docs/dashboard branch January 15, 2026 19:39
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Jan 15, 2026

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
dashboard 113 14 -99

History

@clintandrewhall clintandrewhall mentioned this pull request Feb 27, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nreese nreese nreese approved these changes

Assignees

No one assigned

Labels

backport:skip This PR does not require backporting release_note:skip Skip the PR/issue when compiling release notes review v9.4.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@clintandrewhall @elasticmachine @nreese