docs(readme): retitle, add capability list and REST-vs-MCP guidance#26
Merged
Conversation
Retitle the README to name both surfaces ("IDC REST API & MCP Server").
Add a "What you can do" section: a brief feature-level capability list
(discover, cohorts, retrieval, SQL, clinical data, licenses/citations)
plus a short "REST or MCP?" paragraph on when to use which, pointing at
the user guide for the full reference. Slim the status blockquote so the
capability enumeration lives in one place.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s README to more clearly present IDC’s two public query surfaces (REST API and MCP server) and to provide a feature-level capability overview for readers landing on the repository.
Changes:
- Retitles the README to reflect both the REST API and MCP server surfaces.
- Adds a “What you can do” capability list and a short “REST or MCP?” usage guide.
- Simplifies the status blockquote by moving capability enumeration into the new dedicated section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The CI badge (README) and the private vulnerability-report link (SECURITY.md) still pointed at the pre-transfer fedorov/ repo path. Co-Authored-By: Claude Fable 5 <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
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
fedorov/path.Docs-only; no user-visible API change, so no CHANGELOG entry per the changelog rule.
🤖 Generated with Claude Code