Skip to main content
Glama
20251009-0014-readme-documentation.md2.19 kB
--- story_id: "0014" title: "README and basic documentation" created: "2025-10-09" status: done dependencies: ["0001", "0004"] estimated_complexity: "low" tags: ["documentation", "phase1"] - status: in-progress timestamp: 2025-10-10T02:33:35Z - status: ready-for-review timestamp: 2025-10-10T02:38:39Z - status: done timestamp: 2025-10-10T02:44:00Z --- # Story 0014: README and basic documentation ## Description Create comprehensive README.md with project overview, installation instructions, configuration guide, and usage examples. This is the primary entry point for developers discovering mcp-test-mcp. ## Acceptance Criteria - [x] `README.md` created at project root - [x] Project overview and purpose explained - [x] Installation instructions (pip install, venv setup) - [x] Claude Code/Desktop configuration example provided - [x] Basic usage examples included - [x] Links to detailed documentation - [x] Contributing guidelines mentioned - [x] License information included - [x] Badges for build status, coverage (if applicable) - [x] Quick start guide for first-time users ## Technical Notes **Key sections:** 1. **Overview** - What is mcp-test-mcp and why use it 2. **The Problem** - Brief explanation of the broken loop 3. **Installation** - Step-by-step installation guide 4. **Configuration** - Claude Code MCP settings JSON example 5. **Quick Start** - First connection example 6. **Usage Examples** - Common workflows 7. **Documentation** - Links to detailed docs 8. **Contributing** - How to contribute 9. **License** - License information **Configuration example:** ```json { "mcpServers": { "mcp-test-mcp": { "command": "python", "args": ["-m", "mcp_test_mcp"], "transport": "stdio" } } } ``` ## AI Directives **IMPORTANT**: As you work through this story, please mark checklist items as complete `[x]` as you finish them. This ensures that if we need to pause and resume work, we have a clear record of progress. Update the `status` field in the frontmatter when moving between stages (in-progress, ready-for-review, done, blocked). Make README accessible to developers new to MCP. Include concrete examples.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/rdwj/mcp-test-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server