fix(clippy): add doc comment for generated tool attr fn #439
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RobJellinghaus
changed the title
RobJellinghaus
force-pushed
the
issue-438
branch
4 times, most recently
from
8cb34bc to
8a7ae35
Compare
This change makes the `tool` macro's output safe for the `missing_docs` lint, by emitting a doc comment for the generated `[tool]_tool_attr` function. This doc comment is emitted regardless of whether the tool function is public, for simplicity. We are building an MCP server using `rmcp` and discovered that the current crate was not compatible with the `#![deny(missing_docs)]` lint which we use everywhere. Tested by modifying the `test_tool_macros.rs` test to use `#![deny(missing_docs)]` and adding doc comments to all pub fns and structs in that file. None. Fixes modelcontextprotocol#438.
RobJellinghaus
force-pushed
the
issue-438
branch
from
8a7ae35 to
116d8a4
Compare
RobJellinghaus
changed the title
4t145
approved these changes
Sep 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change makes the
toolmacro's output safe for themissing_docslint, by emitting a doc comment for the generated[tool]_tool_attrfunction. This doc comment is emitted regardless of whether the tool function is public, for simplicity.Motivation and Context
We are building an MCP server using
rmcpand discovered that the current crate was not compatible with the#![deny(missing_docs)]lint which we use everywhere.How Has This Been Tested?
Tested by modifying the
test_tool_macros.rstest to use#![deny(missing_docs)]and adding doc comments to all pub fns and structs in that file.Breaking Changes
None.
Types of changes
Fixes #438
Checklist