PROMPT 09 Documentation
# Implementation Prompt 09: Documentation and README
**Goal:** Create comprehensive user-facing documentation including README, usage examples, and configuration guide.
**Test Strategy:** Documentation must be accurate, complete, and match actual implementation.
---
## Context: What You're Building
You're creating the final user-facing documentation that:
1. **README.md**: Project overview, quick start, API reference
2. **Usage examples**: Common patterns and recipes
3. **Configuration guide**: All options explained
4. **Troubleshooting**: Common issues and solutions
This documentation is for library users, not contributors.
---
## Required Reading: MVP Scope
From MVP_SPEC.md and ADR-0010:
### MVP Features (Document These)
**Transports:**
- Stdio (subprocess via Port)
**MCP Methods:**
- Tools: list, call
- Resources: list, read, templates/list
- Prompts: list, get
- General: ping
**Reliability:**
- Automatic reconnection with exponential backoff
- Request timeout handling
- Transport busy retry (3 attempts)
- Tombstone-based duplicate prevention
**Configuration:**
- All timeout values
- Backoff parameters
- Retry parameters
- Notification handlers
### NOT in MVP (Don't Document)
- SSE/HTTP transports
- Session IDs or session management
- Async notification handlers
- Connection pooling
- Request cancellation API
- Telemetry (mentioned but not required)
---
## Implementation Requirements
### 1. Main README
**File: `README.md`**when to use it
Community prompt sourced from the open-source GitHub repo nshkrdotcom/mcp_client (MIT). A "PROMPT 09 Documentation" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.
tags
businesscommunitygeneral
source
nshkrdotcom/mcp_client · MIT