Enforce SEC filing read locators#2
Open
gyx09212214-prog wants to merge 1 commit into
Open
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
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.
Summary
sec_filing_readlocator contract in the Zod schemayearfor 10-K reads whenaccession_numberis omittedyearandquarterfor 10-Q reads whenaccession_numberis omittedWhy
The tool description already tells agents that 10-K reads need
yearand 10-Q reads needyear+quarterunless they pass an exactaccession_number. The schema did not enforce that contract, so an MCP client could send an under-specified request to the Web API and only discover the problem downstream.This keeps the progressive disclosure flow tighter: browse first when needed, or pass a complete filing locator before calling
sec_filing_read.Tests
node --import tsx --test src\\tools\\sec-tools.test.tsnpm run typechecknpm run lintnpm test