everything: misleading names in get-resource-links (isOdd) and copy-pasted JSDoc tool names
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- devtools, documentation
Research direction
Read src/everything/tools/get-resource-links.ts, src/everything/tools/trigger-long-running-operation.ts, and docs/features.md; the prior PRs #4503 and #4769 are described as prototypes for the refactored code. Rename the misleading flag, document the even/odd ID mapping, and correct each JSDoc tool name. Done when the flag matches its behavior, the mapping is documented, and both headers match the tools their files register.
Written by the indexing model from the issue text.
Description
Problem
Two small naming slips in the everything server, which people read to learn the protocol:
- In
src/everything/tools/get-resource-links.ts, the flagisOddis computed asresourceId % 2 === 0, so it is true for even IDs (which get Text resources). The behavior is right; the name says the opposite, anddocs/features.mddoesn't say which IDs map to which resource type. - The JSDoc header in
src/everything/tools/get-resource-links.tsnames theget-resource-referencetool (copied from its neighbor), and the one insrc/everything/tools/trigger-long-running-operation.tsmisspells its tool's name.
Expected
Rename the flag (for example to isText), document the even/odd mapping, and have each JSDoc header name the tool its file registers.
Prior work
- #4503 by @Joosboy
- #4769 by @simpleqt
The PR(s) above targeted the pre-refactor code and are closed as part of the backlog triage in #4875; this issue is where the work continues, with the PR(s) as a prototype. Thank you to their authors.
- Dominant language
- TypeScript
- Stars
- 91.4k
- Forks
- 11.8k
- Avg merge
- 7h 26m
- Merged PRs (30d)
- 130
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from modelcontextprotocol/servers
-
git: README should state plainly that without --repository every reachable repository is in scopeOpendocumentation server-git v2
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
modelcontextprotocol/servers#5225 ·
Maintainers usually reply within 1 day
-
chore v2
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
modelcontextprotocol/servers#5223 ·
Maintainers usually reply within 1 day
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
modelcontextprotocol/servers#5217 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
modelcontextprotocol/servers#5216 ·
Maintainers usually reply within 1 day
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
modelcontextprotocol/servers#5215 ·
Maintainers usually reply within 1 day
All issues in modelcontextprotocol/servers
Similar issues
-
createAI: the ai peer range allows ai@6, which the provider cannot work withPossibly taken @akhil9tiet claimed this today. Openbug
Difficulty 1/5 Under an hour Newbie friendliness 83/100
cloudflare/agents#2690 · 3 comments ·
Maintainers usually reply within 1 day
-
[fullsend] E2E: theme — global-header ignores app.branding.fullLogo (RHDHBUGS-3670)Possibly taken @fullsend-ai-coder claimed this today. Opene2e-failure ready-to-code
Difficulty 1/5 Under an hour Newbie friendliness 78/100
redhat-developer/rhdh-plugin-export-overlays#4503 · 1 comment ·
Maintainers usually reply within 1 day
-
needs triage 📥
Difficulty 1/5 Under an hour Newbie friendliness 86/100
ethereum/ethereum-org-website#19601 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
cloudscape-design/components#5184 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
agilepathway/label-checker#805 ·
Maintainers usually reply within 1 day