microsoft / microsoft/documentdb-mcp
[DX] Generate a tools catalog page
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 4
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 3
Description
Goal
A human-readable index of every tool the server exposes.
What to ship
docs/tools.md (or similar) listing each of the ~18 tools with:
- Tool name and role tier (read / write / management).
- One-line description of what it does.
- Required inputs (schema, with types).
- Example invocation (JSON).
- Example successful response (truncated).
- Notes on when the LLM should pick this tool vs. a similar one.
Generate from source where possible (the MCP server already exposes this metadata).
Acceptance criteria
- Lives in
docs/tools.mdlinked from the README. - Generated by a script in
scripts/so it stays in sync with code. - Includes a sentence on the consolidation principle ("one tool per intent, not one per Mongo command").
Why
Today nobody knows what tools exist without reading source. Closes a major discoverability gap and answers the reviewer's why these 18 tools question (item #4).
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by locating the MCP server metadata that describes its tools and the existing README and scripts/ structure. Add a generator under scripts/ that produces docs/tools.md with the requested tool details, examples, selection notes, and consolidation principle, then link the page from the README. Done means the catalog covers all exposed tools and can be regenerated from source.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100