Improve tool descriptions & schema param docs - #20
Merged
Conversation
Targets the tools Glama scored lowest (B, ~3.1-3.4): added .describe() to every schema field in staking, portfolio, compound, and morpho modules, and expanded tool-level descriptions to cover when to use the tool, the return shape, and key constraints. Affected: estimate_staking_yield, get_portfolio_summary, get_compound_positions, prepare_compound_borrow, prepare_morpho_supply, prepare_morpho_withdraw_collateral. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Glama's tool-score rubric grades each tool's description + schema-parameter documentation. Our lowest-scoring tools (B, ~3.1-3.4) had bare schema fields with no
.describe()and thin tool-level descriptions..describe()to every schema field instaking,portfolio,compound, andmorphoschemas — wallets, chains, markets, periods, protocols, market ids.estimate_staking_yield,get_portfolio_summary,get_compound_positions,prepare_compound_borrow,prepare_morpho_supply,prepare_morpho_withdraw_collateralto cover: when to use, return shape, and key constraints (e.g.maxnot supported for morpho withdrawCollateral).No runtime/API behavior changes — only metadata surfaced to MCP clients.
Test plan
npm run buildpassesnpm test— all 235 tests pass