Skip to content

Commit 6176542

Browse files
committed
docs: revise documentation to emphasize dual value proposition for agentic IDE users
CHANGES - Restructure README to lead with 50% official docs + 50% auto-update value proposition - Target agentic IDE users (VSCode/Cursor with AI assistants) explicitly - Add AI prompts section to CONTRIBUTING.md for high-quality uniform contributions - Include GitHub templates directory structure (.github/ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE) - Move roadmap from CONTRIBUTING.md to README.md with checkbox format - Add mermaid diagram showing auto-update architecture flow - Enhance git workflow with branching patterns and commit types IMPACT - Developers immediately understand zero-maintenance value and official docs access - Contributors have clear guidance on AI-assisted development workflow - Consistent contribution quality through prompts and templates TECHNICAL NOTES - Preserves all existing content while improving information architecture - Positions project value clearly for target developer audience
1 parent 651bb7b commit 6176542

File tree

2 files changed

+66
-31
lines changed

2 files changed

+66
-31
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to Python Dependency Manager MCP Server
22

3-
> Updated on 2025-07-21 by @KemingHe
3+
> Updated on 2025-07-23 by @KemingHe
44
55
Thank you for your interest in contributing! This document provides development setup instructions and guidelines.
66

@@ -27,6 +27,9 @@ docker build -t py-dep-man-companion .
2727

2828
For testing the server locally during development, add this configuration to your VSCode/Cursor `mcp.json`:
2929

30+
>[!IMPORTANT]
31+
> Replace `/path/to/your/python-dependency-manager-companion-mcp-server` with the absolute path to your local repository.
32+
3033
```json
3134
{
3235
"mcp": {
@@ -51,26 +54,44 @@ For testing the server locally during development, add this configuration to you
5154
}
5255
```
5356

54-
>[!IMPORTANT]
55-
> Replace `/path/to/your/python-dependency-manager-companion-mcp-server` with the absolute path to your local repository.
56-
57-
## 🗺️ Roadmap
58-
59-
Adding support for pipenv, pdm, pixi, and additional Python package managers.
60-
6157
## 📝 Development Guidelines
6258

6359
- Follow existing code style and structure
6460
- Test your changes locally using the native configuration above
6561
- Update documentation when adding new features
6662
- Submit pull requests with clear descriptions of changes
6763

64+
### Git Workflow & Branching
65+
66+
- **Branching pattern**: `type/feature-or-bug-scope/GitHubUsername`
67+
- **Types**: `feat`, `fix`, `docs`, `test`, `refactor`, `chore`
68+
69+
### Prompts for AI-Assisted Development
70+
71+
> [!TIP]
72+
> This project includes AI prompts and GitHub templates for consistent, high-quality contributions:
73+
74+
```plaintext
75+
.github/
76+
├── ISSUE_TEMPLATE/
77+
│ ├── bug-report.md # Bug report template
78+
│ └── feature-request.md # Feature request template
79+
└── PULL_REQUEST_TEMPLATE/
80+
└── pull_request_template.md # PR template with checklist
81+
82+
prompts/
83+
├── prompt-commit-msg-gen.md # Generate uniform commit messages
84+
├── prompt-issue-gen.md # Create well-structured issues
85+
├── prompt-pull-request-gen.md # Write comprehensive PR descriptions
86+
└── prompt-readme-gen.md # Maintain documentation standards
87+
```
88+
6889
## 🔄 Automated Updates
6990

7091
This repository includes automated workflows that:
7192

72-
- Update documentation weekly from official sources
73-
- Rebuild search indexes automatically
74-
- Publish multi-architecture Docker images
93+
1. Update documentation weekly from official sources
94+
2. Rebuild search indexes automatically
95+
3. Publish multi-architecture Docker images
7596

7697
See [.github/workflows/README.md](.github/workflows/README.md) for workflow details.

README.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,18 @@
11
# Python Dependency Manager Companion MCP Server
22

3-
> Updated on 2025-07-21 by [@KemingHe](https://github.com/KemingHe)
3+
> README updated on 2025-07-23 by [@KemingHe](https://github.com/KemingHe)
44
5-
Local stdio MCP server providing unified search across Python dependency managers' latest and official documentation. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a)
5+
Official docs from pip, poetry, uv, and conda + automated weekly updates = zero maintenance overhead for developers using VSCode/Cursor with AI assistants. [[Demo]](https://www.loom.com/share/a80f6041dc374c07b95b2397ee4e8ca1?sid=1209cdce-7239-447e-8b20-49eae454cc9a)
66

7-
## 📋 Overview
7+
## 🚀 Quick Start for Agentic IDEs
88

9-
Unified search for pip, poetry, uv, and conda docs via Docker with automated weekly updates. Built with FastMCP and Tantivy for simple, accurate, embedding-free, full-text search.
10-
11-
## 🎯 Use as Template
12-
13-
**General use**: [[Use this repository as a template]](https://github.com/new?template_name=python-dependency-manager-companion-mcp-server&template_owner=KemingHe) for your own MCP server projects.
14-
15-
**Contributing**: Fork to contribute back. See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup.
16-
17-
## 🚀 Getting Started
18-
19-
### Step 1: Pull Docker Image
9+
**1. Pull latest Docker image**:
2010

2111
```shell
2212
docker pull keminghe/py-dep-man-companion:latest
2313
```
2414

25-
### Step 2: Configure Your IDE
26-
27-
Add to VSCode/Cursor `mcp.json`:
15+
**2. Add to your IDE's `mcp.json`**:
2816

2917
```json
3018
{
@@ -39,9 +27,35 @@ Add to VSCode/Cursor `mcp.json`:
3927
}
4028
```
4129

42-
### Step 3: Start Searching
30+
**3. Query official docs directly in your AI chat** - guaranteed fresh from weekly automated updates.
31+
32+
## 🤝 Contributing
33+
34+
**Use as template**: [[Create from template]](https://github.com/new?template_name=python-dependency-manager-companion-mcp-server&template_owner=KemingHe) for your own MCP server projects.
35+
36+
**Contribute back**: Fork and see [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup.
37+
38+
## 🔄 Auto-Update Architecture
39+
40+
```mermaid
41+
graph LR
42+
WEEKLY["⏰ Every Tuesday 06:00pm ET"]
43+
DOCS["📚 Sync Official Docs"]
44+
INDEX["🔍 Rebuild Search Index"]
45+
DOCKER["🐳 Publish Latest Image"]
46+
47+
WEEKLY --> DOCS
48+
DOCS --> INDEX
49+
INDEX --> DOCKER
50+
```
51+
52+
**Zero maintenance**: Documentation automatically synced weekly from official sources. Docker `:latest` tag guarantees you always get current docs without manual updates.
53+
54+
## 🗺️ Roadmap
4355

44-
Query latest and unified documentation across all supported Python dependency managers directly within your agentic chat.
56+
- [ ] Add support for pipenv, pdm, pixi
57+
- [ ] Add comprehensive tests with 100% coverage
58+
- [ ] Add indexing support for PDF and CSV files
4559

4660
## 📁 Project Structure
4761

@@ -73,4 +87,4 @@ This project is licensed under the [MIT License](./LICENSE) - a permissive licen
7387

7488
## 📞 Support
7589

76-
Open GitHub issues for bug reports and feature requests. Documentation is automatically updated weekly via workflows (see [.github/workflows/README.md](./.github/workflows/README.md)).
90+
Open a [GitHub issue](https://github.com/KemingHe/python-dependency-manager-companion-mcp-server/issues) for bug reports and feature requests.

0 commit comments

Comments
 (0)