fix(api): remove ignored tool parameters - #278
Open
nordic-style wants to merge 1 commit into
Open
Conversation
Narrow eight schemas to behavior their handlers can verify, correct overstated tool descriptions, and document a replacement workflow for every public input removal. Refs mixelpixx#251
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
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.
User-visible problem and scope
Eight optional MCP inputs were advertised even though their handlers never read them. A caller could reasonably believe those values changed validation, costing, review, hierarchy, zone refill, or manufacturing output when they did nothing.
This PR removes only those dead inputs, corrects overstated descriptions, and records a supported replacement workflow for every removal.
Refs #251
Root cause and design
Schemas and handlers evolved independently. The unused fields survived because existing tests checked registration and required arguments, but not whether every advertised property reached implementation behavior.
The schemas now match the operations Konnect can verify.
docs/API_MIGRATIONS.mdis the explicit compatibility record, andschema_migrations.rsprevents a removed field from returning without a migration note.Compatibility and migration
Removed fields:
import_sheet_pins.project_namerefill_zones.zonesrun_drc.testsaudit_decoupling.boardaudit_decoupling.max_distance_mmexport_manufacturing_package.quantityvalidate_for_manufacturing.schematicestimate_cost.schematicAll were optional and behaviorally inert, so generated files and analysis results are unchanged. The migration document points callers to project-instance workflows, complete-board zone refill, KiCad DRC configuration, PCB placement inspection,
estimate_cost.quantity,check_bom_health, and board-footprint counting as appropriate.Validation
cargo test -p konnect --test schema_migrations --lockedcargo clippy --workspace --locked --all-targets -- -D warningscargo fmt --all -- --checkkonnect-coretests pass, with only the same three installed-Device:Rfixture-shadowing failures reproduced on unmodifiedmain.Risk and rollback
The intentional API narrowing may expose clients that were sending inert fields. Migration is omission or the documented companion tool; no data format or file write changes. Rollback is one commit, including the migration and regression test.