feat: Developer Experience Overhaul — README restructure + multi-platform setup#7
Open
feat: Developer Experience Overhaul — README restructure + multi-platform setup#7
Conversation
- Restructure README with value-first positioning - Add multi-platform Quick Start (Claude, Cursor, Windsurf, VS Code) - Add comprehensive Available Tools table (all 21 tools categorized) - Add 'Why Nutrient?' section with Read-Write Gap narrative - Add troubleshooting section - Add AI agent framework compatibility list - Improve Examples & Documentation section with table format - Improve package.json keywords for discoverability - Consistent structure with DWS MCP server README
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
This PR overhauls the README for significantly improved developer experience, establishing consistency with the DWS MCP server and making it easier for developers to discover, understand, and adopt the Nutrient Document Engine MCP Server.
Changes
README.md
package.json
Testing
Context
Part of a coordinated DX overhaul across both Nutrient MCP servers to establish consistent, best-in-class developer experience. See companion PR on nutrient-dws-mcp-server: PSPDFKit/nutrient-dws-mcp-server#11