Skip to content

Commit 55a25c7

Browse files
committed
docs: add contributing guide and update readme
CHANGES - Add comprehensive CONTRIBUTING.md with development setup instructions - Update README.md with demo link and enhanced project description - Reorganize content by moving development details to contributing guide - Update project date and improve section organization IMPACT - Contributors have clear setup and development guidelines - README is more focused on user getting-started experience - Better project organization with separated concerns
1 parent eb1617c commit 55a25c7

File tree

2 files changed

+86
-25
lines changed

2 files changed

+86
-25
lines changed

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing to Python Dependency Manager MCP Server
2+
3+
> Updated on 2025-07-21 by @KemingHe
4+
5+
Thank you for your interest in contributing! This document provides development setup instructions and guidelines.
6+
7+
## 🛠️ Development Setup
8+
9+
**Transport**: Stdio only (MCP standard for local tools).
10+
11+
### Local Development
12+
13+
```shell
14+
# Clone and setup
15+
git clone <repo-url>
16+
cd python-dep-manager-companion-mcp-server
17+
uv sync
18+
19+
# Run server locally
20+
uv run --with fastmcp --with tantivy fastmcp run src/mcp_server.py
21+
22+
# Build Docker image
23+
docker build -t py-dep-man-companion .
24+
```
25+
26+
### Local Testing with MCP Client
27+
28+
For testing the server locally during development, add this configuration to your VSCode/Cursor `mcp.json`:
29+
30+
```json
31+
{
32+
"mcp": {
33+
"servers": {
34+
"py-dep-man-companion-native": {
35+
"command": "uv",
36+
"args": [
37+
"run",
38+
"--directory",
39+
"/path/to/your/python-dependency-manager-companion-mcp-server",
40+
"--with",
41+
"fastmcp>=2.10.5",
42+
"--with",
43+
"tantivy>=0.24.0",
44+
"fastmcp",
45+
"run",
46+
"src/mcp_server.py"
47+
]
48+
}
49+
}
50+
}
51+
}
52+
```
53+
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+
61+
## 📝 Development Guidelines
62+
63+
- Follow existing code style and structure
64+
- Test your changes locally using the native configuration above
65+
- Update documentation when adding new features
66+
- Submit pull requests with clear descriptions of changes
67+
68+
## 🔄 Automated Updates
69+
70+
This repository includes automated workflows that:
71+
72+
- Update documentation weekly from official sources
73+
- Rebuild search indexes automatically
74+
- Publish multi-architecture Docker images
75+
76+
See [.github/workflows/README.md](.github/workflows/README.md) for workflow details.

README.md

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
# Python Dependency Manager MCP Server
22

3-
> Updated on 2025-07-15 by @KemingHe
3+
> Updated on 2025-07-21 by @KemingHe
44
5-
Local stdio MCP server providing unified search across Python dependency managers' latest and official documentation.
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)
66

77
## 📋 Overview
88

9-
Unified search for pip, poetry, uv, and conda docs via Docker with automated weekly updates. Built with FastMCP and Tantivy for simple, AI-less full-text search.
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 only to contribute back._ See [./CONTRIBUTING.md](./CONTRIBUTING.md) for development setup.
1016

1117
## 🚀 Getting Started
1218

@@ -61,31 +67,10 @@ python-dep-manager-companion-mcp-server/
6167
└── uv.lock # Locked dependencies
6268
```
6369

64-
## 🛠️ Development
65-
66-
**Transport**: Stdio only (MCP standard for local tools).
67-
68-
**Local Development**:
69-
70-
```shell
71-
# Clone and setup
72-
git clone <repo-url>
73-
cd python-dep-manager-companion-mcp-server
74-
uv sync
75-
76-
# Run server locally
77-
uv run --with fastmcp --with tantivy fastmcp run src/mcp_server.py
78-
79-
# Build Docker image
80-
docker build -t py-dep-man-companion .
81-
```
82-
83-
**Roadmap**: Adding support for pipenv, pdm, pixi, and additional Python package managers.
84-
8570
## 📄 License
8671

8772
This project is licensed under the [MIT License](./LICENSE) - a permissive license that allows free use, modification, and distribution with attribution.
8873

8974
## 📞 Support
9075

91-
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)).
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)).

0 commit comments

Comments
 (0)