@mhalder/qdrant-mcp-server 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/CHANGELOG.md +82 -69
  2. package/CONTRIBUTING.md +81 -92
  3. package/README.md +97 -634
  4. package/examples/README.md +63 -253
  5. package/examples/basic/README.md +18 -72
  6. package/examples/filters/README.md +55 -155
  7. package/examples/knowledge-base/README.md +36 -98
  8. package/examples/rate-limiting/README.md +81 -290
  9. package/package.json +1 -1
  10. package/docs/test_report.md +0 -259
package/CHANGELOG.md CHANGED
@@ -1,73 +1,86 @@
1
- ## 1.1.0 (2025-10-11)
1
+ ## <small>1.1.1 (2025-10-11)</small>
2
2
 
3
- * feat: enable scoped package publishing ([6b1b33f](https://github.com/mhalder/qdrant-mcp-server/commit/6b1b33f))
4
- * chore: scope package to @mhalder namespace for npm publishing ([9518827](https://github.com/mhalder/qdrant-mcp-server/commit/9518827))
3
+ * Merge pull request #22 from mhalder/docs/clean-and-condense ([991cb9d](https://github.com/mhalder/qdrant-mcp-server/commit/991cb9d)), closes [#22](https://github.com/mhalder/qdrant-mcp-server/issues/22)
4
+ * docs: clean and condense all documentation ([9f54ab8](https://github.com/mhalder/qdrant-mcp-server/commit/9f54ab8))
5
+ * docs: improve consistency and remove redundancy across all documentation ([176cb05](https://github.com/mhalder/qdrant-mcp-server/commit/176cb05))
6
+ * docs: remove test report and references - redundant with CI ([db0b8b7](https://github.com/mhalder/qdrant-mcp-server/commit/db0b8b7))
7
+ * docs: streamline README for clarity and conciseness ([bd34c91](https://github.com/mhalder/qdrant-mcp-server/commit/bd34c91))
8
+
9
+ ## [1.1.0](https://github.com/mhalder/qdrant-mcp-server/compare/v1.0.0...v1.1.0) (2025-10-11)
10
+
11
+ ### Features
12
+
13
+ - Enable scoped package publishing ([6b1b33f](https://github.com/mhalder/qdrant-mcp-server/commit/6b1b33f))
14
+
15
+ ### Maintenance
16
+
17
+ - Scope package to @mhalder namespace for npm publishing ([9518827](https://github.com/mhalder/qdrant-mcp-server/commit/9518827))
5
18
 
6
19
  ## 1.0.0 (2025-10-11)
7
20
 
8
- * chore: add docker compose configuration for qdrant ([ad1773f](https://github.com/mhalder/qdrant-mcp-server/commit/ad1773f))
9
- * chore: add environment configuration template ([872be20](https://github.com/mhalder/qdrant-mcp-server/commit/872be20))
10
- * chore: add ollama_storage to .gitignore ([4fb550e](https://github.com/mhalder/qdrant-mcp-server/commit/4fb550e))
11
- * chore: configure semantic-release for automated versioning ([fb1d64a](https://github.com/mhalder/qdrant-mcp-server/commit/fb1d64a))
12
- * chore: initial project setup ([7930b0f](https://github.com/mhalder/qdrant-mcp-server/commit/7930b0f))
13
- * "Claude Code Review workflow" ([8739c72](https://github.com/mhalder/qdrant-mcp-server/commit/8739c72))
14
- * "Claude PR Assistant workflow" ([01ad2e7](https://github.com/mhalder/qdrant-mcp-server/commit/01ad2e7))
15
- * Merge pull request #12 from mhalder/add-claude-github-actions-1759866978728 ([6783076](https://github.com/mhalder/qdrant-mcp-server/commit/6783076)), closes [#12](https://github.com/mhalder/qdrant-mcp-server/issues/12)
16
- * Merge pull request #13 from mhalder/examples-directory ([9e7c312](https://github.com/mhalder/qdrant-mcp-server/commit/9e7c312)), closes [#13](https://github.com/mhalder/qdrant-mcp-server/issues/13)
17
- * Merge pull request #15 from mhalder/add-mit-license ([6e9525d](https://github.com/mhalder/qdrant-mcp-server/commit/6e9525d)), closes [#15](https://github.com/mhalder/qdrant-mcp-server/issues/15)
18
- * Merge pull request #16 from mhalder/feat/rate-limiting-issue-6 ([fa3601e](https://github.com/mhalder/qdrant-mcp-server/commit/fa3601e)), closes [#16](https://github.com/mhalder/qdrant-mcp-server/issues/16)
19
- * Merge pull request #17 from mhalder/feat/alternative-embedding-providers-issue-2 ([4670e29](https://github.com/mhalder/qdrant-mcp-server/commit/4670e29)), closes [#17](https://github.com/mhalder/qdrant-mcp-server/issues/17)
20
- * Merge pull request #19 from mhalder/feat/use-ollama-as-default-issue-18 ([8b1075f](https://github.com/mhalder/qdrant-mcp-server/commit/8b1075f)), closes [#19](https://github.com/mhalder/qdrant-mcp-server/issues/19)
21
- * test: add comprehensive tests for embedding provider architecture ([b2db1b4](https://github.com/mhalder/qdrant-mcp-server/commit/b2db1b4))
22
- * test: add comprehensive unit tests for openai embeddings ([466a012](https://github.com/mhalder/qdrant-mcp-server/commit/466a012))
23
- * test: add comprehensive unit tests for qdrant client ([0f6c3a9](https://github.com/mhalder/qdrant-mcp-server/commit/0f6c3a9))
24
- * test: add comprehensive validation tests for environment variables ([1ae89b6](https://github.com/mhalder/qdrant-mcp-server/commit/1ae89b6))
25
- * test: add functional testing round 3 for multi-provider architecture ([9588810](https://github.com/mhalder/qdrant-mcp-server/commit/9588810))
26
- * test: add integration tests for mcp server tools ([b504329](https://github.com/mhalder/qdrant-mcp-server/commit/b504329))
27
- * test: add interactive MCP testing round 4 results ([0cdc763](https://github.com/mhalder/qdrant-mcp-server/commit/0cdc763))
28
- * test: add testing infrastructure with vitest ([35beed7](https://github.com/mhalder/qdrant-mcp-server/commit/35beed7))
29
- * test: fix error handling tests and improve coverage ([1219574](https://github.com/mhalder/qdrant-mcp-server/commit/1219574))
30
- * test: improve coverage for error handling paths ([833b3ef](https://github.com/mhalder/qdrant-mcp-server/commit/833b3ef))
31
- * test: improve coverage reporting to 95.75% ([0a061d2](https://github.com/mhalder/qdrant-mcp-server/commit/0a061d2))
32
- * test: update test expectations for ID normalization and document feature ([dce948d](https://github.com/mhalder/qdrant-mcp-server/commit/dce948d))
33
- * fix: add copyright holder to LICENSE file ([d4f926b](https://github.com/mhalder/qdrant-mcp-server/commit/d4f926b))
34
- * fix: add package-lock.json for reproducible builds ([ffc6385](https://github.com/mhalder/qdrant-mcp-server/commit/ffc6385))
35
- * fix: add type guard for message.toLowerCase() call ([b622650](https://github.com/mhalder/qdrant-mcp-server/commit/b622650))
36
- * fix: add validation for Retry-After header parsing ([f6e2d0f](https://github.com/mhalder/qdrant-mcp-server/commit/f6e2d0f))
37
- * fix: address code quality issues and version mismatch ([8f48300](https://github.com/mhalder/qdrant-mcp-server/commit/8f48300))
38
- * fix: convert simple key-value filters to Qdrant filter format ([cf7f684](https://github.com/mhalder/qdrant-mcp-server/commit/cf7f684))
39
- * fix: generate coverage files before Codecov upload ([5e7369c](https://github.com/mhalder/qdrant-mcp-server/commit/5e7369c))
40
- * fix: improve API key validation and Ollama error messages ([a556358](https://github.com/mhalder/qdrant-mcp-server/commit/a556358)), closes [#19](https://github.com/mhalder/qdrant-mcp-server/issues/19)
41
- * fix: normalize string IDs to UUID format and enhance error handling ([75478e3](https://github.com/mhalder/qdrant-mcp-server/commit/75478e3))
42
- * fix: select provider-specific API key in factory ([be2ed4b](https://github.com/mhalder/qdrant-mcp-server/commit/be2ed4b))
43
- * feat: add Ollama model existence validation on startup ([3086563](https://github.com/mhalder/qdrant-mcp-server/commit/3086563))
44
- * feat: add support for alternative embedding providers ([3762c43](https://github.com/mhalder/qdrant-mcp-server/commit/3762c43)), closes [#2](https://github.com/mhalder/qdrant-mcp-server/issues/2)
45
- * feat: implement mcp server with semantic search tools ([3b99fce](https://github.com/mhalder/qdrant-mcp-server/commit/3b99fce))
46
- * feat: implement OpenAI API rate limiting with exponential backoff ([c619570](https://github.com/mhalder/qdrant-mcp-server/commit/c619570)), closes [#6](https://github.com/mhalder/qdrant-mcp-server/issues/6)
47
- * feat: implement openai embeddings provider ([e44c50c](https://github.com/mhalder/qdrant-mcp-server/commit/e44c50c))
48
- * feat: implement qdrant client wrapper ([3195e63](https://github.com/mhalder/qdrant-mcp-server/commit/3195e63))
49
- * feat: support both simple and Qdrant filter formats ([e5bb8fe](https://github.com/mhalder/qdrant-mcp-server/commit/e5bb8fe))
50
- * feat: use Ollama as default embedding provider ([4342591](https://github.com/mhalder/qdrant-mcp-server/commit/4342591)), closes [#18](https://github.com/mhalder/qdrant-mcp-server/issues/18)
51
- * docs: add Codecov badge to README ([fff50d2](https://github.com/mhalder/qdrant-mcp-server/commit/fff50d2))
52
- * docs: add comment about Bottleneck reservoir configuration ([252fa9f](https://github.com/mhalder/qdrant-mcp-server/commit/252fa9f))
53
- * docs: add comprehensive examples directory ([7ef9cf5](https://github.com/mhalder/qdrant-mcp-server/commit/7ef9cf5)), closes [#4](https://github.com/mhalder/qdrant-mcp-server/issues/4)
54
- * docs: add comprehensive README with setup instructions ([4517207](https://github.com/mhalder/qdrant-mcp-server/commit/4517207))
55
- * docs: add functional test report ([c0838bf](https://github.com/mhalder/qdrant-mcp-server/commit/c0838bf))
56
- * docs: add MIT LICENSE file and update README ([3e427df](https://github.com/mhalder/qdrant-mcp-server/commit/3e427df))
57
- * docs: add testing documentation to README ([cb5d62b](https://github.com/mhalder/qdrant-mcp-server/commit/cb5d62b))
58
- * docs: comprehensive update to README with filtering examples ([66ec1b5](https://github.com/mhalder/qdrant-mcp-server/commit/66ec1b5))
59
- * docs: streamline test report with latest MCP integration results ([b30cd04](https://github.com/mhalder/qdrant-mcp-server/commit/b30cd04))
60
- * docs: update CI badge with correct GitHub username ([9d8bdfb](https://github.com/mhalder/qdrant-mcp-server/commit/9d8bdfb))
61
- * docs: update configuration for claude code on linux ([429d514](https://github.com/mhalder/qdrant-mcp-server/commit/429d514))
62
- * docs: update documentation for multi-provider support ([18196a1](https://github.com/mhalder/qdrant-mcp-server/commit/18196a1))
63
- * docs: update documentation for Ollama as default provider ([60818dd](https://github.com/mhalder/qdrant-mcp-server/commit/60818dd))
64
- * docs: update examples and version for Ollama as default ([eb7bd4d](https://github.com/mhalder/qdrant-mcp-server/commit/eb7bd4d))
65
- * docs: update test report and README with v2 integration test results ([1ff1e22](https://github.com/mhalder/qdrant-mcp-server/commit/1ff1e22))
66
- * ci: add GitHub Actions workflow for automated testing ([9420261](https://github.com/mhalder/qdrant-mcp-server/commit/9420261))
67
- * ci: add provider verification tests to GitHub Actions ([f4d1f7d](https://github.com/mhalder/qdrant-mcp-server/commit/f4d1f7d))
68
- * ci: remove Node.js 18.x from test matrix ([bf5f478](https://github.com/mhalder/qdrant-mcp-server/commit/bf5f478))
69
- * ci: test Codecov integration with updated token ([60b5f2c](https://github.com/mhalder/qdrant-mcp-server/commit/60b5f2c))
70
- * style: format CI workflow with yamlfmt ([cedf0f8](https://github.com/mhalder/qdrant-mcp-server/commit/cedf0f8))
71
- * perf: optimize Ollama batch embedding with parallel processing ([7736c32](https://github.com/mhalder/qdrant-mcp-server/commit/7736c32))
72
- * refactor: move verification script to scripts/ folder ([a25373f](https://github.com/mhalder/qdrant-mcp-server/commit/a25373f))
73
- * refactor: replace error:any with typed OpenAIError interface ([08a0d23](https://github.com/mhalder/qdrant-mcp-server/commit/08a0d23))
21
+ - chore: add docker compose configuration for qdrant ([ad1773f](https://github.com/mhalder/qdrant-mcp-server/commit/ad1773f))
22
+ - chore: add environment configuration template ([872be20](https://github.com/mhalder/qdrant-mcp-server/commit/872be20))
23
+ - chore: add ollama_storage to .gitignore ([4fb550e](https://github.com/mhalder/qdrant-mcp-server/commit/4fb550e))
24
+ - chore: configure semantic-release for automated versioning ([fb1d64a](https://github.com/mhalder/qdrant-mcp-server/commit/fb1d64a))
25
+ - chore: initial project setup ([7930b0f](https://github.com/mhalder/qdrant-mcp-server/commit/7930b0f))
26
+ - "Claude Code Review workflow" ([8739c72](https://github.com/mhalder/qdrant-mcp-server/commit/8739c72))
27
+ - "Claude PR Assistant workflow" ([01ad2e7](https://github.com/mhalder/qdrant-mcp-server/commit/01ad2e7))
28
+ - Merge pull request #12 from mhalder/add-claude-github-actions-1759866978728 ([6783076](https://github.com/mhalder/qdrant-mcp-server/commit/6783076)), closes [#12](https://github.com/mhalder/qdrant-mcp-server/issues/12)
29
+ - Merge pull request #13 from mhalder/examples-directory ([9e7c312](https://github.com/mhalder/qdrant-mcp-server/commit/9e7c312)), closes [#13](https://github.com/mhalder/qdrant-mcp-server/issues/13)
30
+ - Merge pull request #15 from mhalder/add-mit-license ([6e9525d](https://github.com/mhalder/qdrant-mcp-server/commit/6e9525d)), closes [#15](https://github.com/mhalder/qdrant-mcp-server/issues/15)
31
+ - Merge pull request #16 from mhalder/feat/rate-limiting-issue-6 ([fa3601e](https://github.com/mhalder/qdrant-mcp-server/commit/fa3601e)), closes [#16](https://github.com/mhalder/qdrant-mcp-server/issues/16)
32
+ - Merge pull request #17 from mhalder/feat/alternative-embedding-providers-issue-2 ([4670e29](https://github.com/mhalder/qdrant-mcp-server/commit/4670e29)), closes [#17](https://github.com/mhalder/qdrant-mcp-server/issues/17)
33
+ - Merge pull request #19 from mhalder/feat/use-ollama-as-default-issue-18 ([8b1075f](https://github.com/mhalder/qdrant-mcp-server/commit/8b1075f)), closes [#19](https://github.com/mhalder/qdrant-mcp-server/issues/19)
34
+ - test: add comprehensive tests for embedding provider architecture ([b2db1b4](https://github.com/mhalder/qdrant-mcp-server/commit/b2db1b4))
35
+ - test: add comprehensive unit tests for openai embeddings ([466a012](https://github.com/mhalder/qdrant-mcp-server/commit/466a012))
36
+ - test: add comprehensive unit tests for qdrant client ([0f6c3a9](https://github.com/mhalder/qdrant-mcp-server/commit/0f6c3a9))
37
+ - test: add comprehensive validation tests for environment variables ([1ae89b6](https://github.com/mhalder/qdrant-mcp-server/commit/1ae89b6))
38
+ - test: add functional testing round 3 for multi-provider architecture ([9588810](https://github.com/mhalder/qdrant-mcp-server/commit/9588810))
39
+ - test: add integration tests for mcp server tools ([b504329](https://github.com/mhalder/qdrant-mcp-server/commit/b504329))
40
+ - test: add interactive MCP testing round 4 results ([0cdc763](https://github.com/mhalder/qdrant-mcp-server/commit/0cdc763))
41
+ - test: add testing infrastructure with vitest ([35beed7](https://github.com/mhalder/qdrant-mcp-server/commit/35beed7))
42
+ - test: fix error handling tests and improve coverage ([1219574](https://github.com/mhalder/qdrant-mcp-server/commit/1219574))
43
+ - test: improve coverage for error handling paths ([833b3ef](https://github.com/mhalder/qdrant-mcp-server/commit/833b3ef))
44
+ - test: improve coverage reporting to 95.75% ([0a061d2](https://github.com/mhalder/qdrant-mcp-server/commit/0a061d2))
45
+ - test: update test expectations for ID normalization and document feature ([dce948d](https://github.com/mhalder/qdrant-mcp-server/commit/dce948d))
46
+ - fix: add copyright holder to LICENSE file ([d4f926b](https://github.com/mhalder/qdrant-mcp-server/commit/d4f926b))
47
+ - fix: add package-lock.json for reproducible builds ([ffc6385](https://github.com/mhalder/qdrant-mcp-server/commit/ffc6385))
48
+ - fix: add type guard for message.toLowerCase() call ([b622650](https://github.com/mhalder/qdrant-mcp-server/commit/b622650))
49
+ - fix: add validation for Retry-After header parsing ([f6e2d0f](https://github.com/mhalder/qdrant-mcp-server/commit/f6e2d0f))
50
+ - fix: address code quality issues and version mismatch ([8f48300](https://github.com/mhalder/qdrant-mcp-server/commit/8f48300))
51
+ - fix: convert simple key-value filters to Qdrant filter format ([cf7f684](https://github.com/mhalder/qdrant-mcp-server/commit/cf7f684))
52
+ - fix: generate coverage files before Codecov upload ([5e7369c](https://github.com/mhalder/qdrant-mcp-server/commit/5e7369c))
53
+ - fix: improve API key validation and Ollama error messages ([a556358](https://github.com/mhalder/qdrant-mcp-server/commit/a556358)), closes [#19](https://github.com/mhalder/qdrant-mcp-server/issues/19)
54
+ - fix: normalize string IDs to UUID format and enhance error handling ([75478e3](https://github.com/mhalder/qdrant-mcp-server/commit/75478e3))
55
+ - fix: select provider-specific API key in factory ([be2ed4b](https://github.com/mhalder/qdrant-mcp-server/commit/be2ed4b))
56
+ - feat: add Ollama model existence validation on startup ([3086563](https://github.com/mhalder/qdrant-mcp-server/commit/3086563))
57
+ - feat: add support for alternative embedding providers ([3762c43](https://github.com/mhalder/qdrant-mcp-server/commit/3762c43)), closes [#2](https://github.com/mhalder/qdrant-mcp-server/issues/2)
58
+ - feat: implement mcp server with semantic search tools ([3b99fce](https://github.com/mhalder/qdrant-mcp-server/commit/3b99fce))
59
+ - feat: implement OpenAI API rate limiting with exponential backoff ([c619570](https://github.com/mhalder/qdrant-mcp-server/commit/c619570)), closes [#6](https://github.com/mhalder/qdrant-mcp-server/issues/6)
60
+ - feat: implement openai embeddings provider ([e44c50c](https://github.com/mhalder/qdrant-mcp-server/commit/e44c50c))
61
+ - feat: implement qdrant client wrapper ([3195e63](https://github.com/mhalder/qdrant-mcp-server/commit/3195e63))
62
+ - feat: support both simple and Qdrant filter formats ([e5bb8fe](https://github.com/mhalder/qdrant-mcp-server/commit/e5bb8fe))
63
+ - feat: use Ollama as default embedding provider ([4342591](https://github.com/mhalder/qdrant-mcp-server/commit/4342591)), closes [#18](https://github.com/mhalder/qdrant-mcp-server/issues/18)
64
+ - docs: add Codecov badge to README ([fff50d2](https://github.com/mhalder/qdrant-mcp-server/commit/fff50d2))
65
+ - docs: add comment about Bottleneck reservoir configuration ([252fa9f](https://github.com/mhalder/qdrant-mcp-server/commit/252fa9f))
66
+ - docs: add comprehensive examples directory ([7ef9cf5](https://github.com/mhalder/qdrant-mcp-server/commit/7ef9cf5)), closes [#4](https://github.com/mhalder/qdrant-mcp-server/issues/4)
67
+ - docs: add comprehensive README with setup instructions ([4517207](https://github.com/mhalder/qdrant-mcp-server/commit/4517207))
68
+ - docs: add functional test report ([c0838bf](https://github.com/mhalder/qdrant-mcp-server/commit/c0838bf))
69
+ - docs: add MIT LICENSE file and update README ([3e427df](https://github.com/mhalder/qdrant-mcp-server/commit/3e427df))
70
+ - docs: add testing documentation to README ([cb5d62b](https://github.com/mhalder/qdrant-mcp-server/commit/cb5d62b))
71
+ - docs: comprehensive update to README with filtering examples ([66ec1b5](https://github.com/mhalder/qdrant-mcp-server/commit/66ec1b5))
72
+ - docs: streamline test report with latest MCP integration results ([b30cd04](https://github.com/mhalder/qdrant-mcp-server/commit/b30cd04))
73
+ - docs: update CI badge with correct GitHub username ([9d8bdfb](https://github.com/mhalder/qdrant-mcp-server/commit/9d8bdfb))
74
+ - docs: update configuration for claude code on linux ([429d514](https://github.com/mhalder/qdrant-mcp-server/commit/429d514))
75
+ - docs: update documentation for multi-provider support ([18196a1](https://github.com/mhalder/qdrant-mcp-server/commit/18196a1))
76
+ - docs: update documentation for Ollama as default provider ([60818dd](https://github.com/mhalder/qdrant-mcp-server/commit/60818dd))
77
+ - docs: update examples and version for Ollama as default ([eb7bd4d](https://github.com/mhalder/qdrant-mcp-server/commit/eb7bd4d))
78
+ - docs: update test report and README with v2 integration test results ([1ff1e22](https://github.com/mhalder/qdrant-mcp-server/commit/1ff1e22))
79
+ - ci: add GitHub Actions workflow for automated testing ([9420261](https://github.com/mhalder/qdrant-mcp-server/commit/9420261))
80
+ - ci: add provider verification tests to GitHub Actions ([f4d1f7d](https://github.com/mhalder/qdrant-mcp-server/commit/f4d1f7d))
81
+ - ci: remove Node.js 18.x from test matrix ([bf5f478](https://github.com/mhalder/qdrant-mcp-server/commit/bf5f478))
82
+ - ci: test Codecov integration with updated token ([60b5f2c](https://github.com/mhalder/qdrant-mcp-server/commit/60b5f2c))
83
+ - style: format CI workflow with yamlfmt ([cedf0f8](https://github.com/mhalder/qdrant-mcp-server/commit/cedf0f8))
84
+ - perf: optimize Ollama batch embedding with parallel processing ([7736c32](https://github.com/mhalder/qdrant-mcp-server/commit/7736c32))
85
+ - refactor: move verification script to scripts/ folder ([a25373f](https://github.com/mhalder/qdrant-mcp-server/commit/a25373f))
86
+ - refactor: replace error:any with typed OpenAIError interface ([08a0d23](https://github.com/mhalder/qdrant-mcp-server/commit/08a0d23))
package/CONTRIBUTING.md CHANGED
@@ -1,59 +1,46 @@
1
- # Contributing to qdrant-mcp-server
1
+ # Contributing
2
2
 
3
- Thank you for your interest in contributing to qdrant-mcp-server! This document provides guidelines and instructions for contributing to the project.
4
-
5
- ## Code of Conduct
6
-
7
- Please be respectful and constructive in your interactions with other contributors.
3
+ Thank you for your interest in contributing!
8
4
 
9
5
  ## Getting Started
10
6
 
11
- 1. Fork the repository
12
- 2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/qdrant-mcp-server.git`
13
- 3. Install dependencies: `npm install`
14
- 4. Create a branch for your changes: `git checkout -b feat/your-feature-name`
15
-
16
- ## Development Workflow
17
-
18
- ### Running the Project
19
-
20
7
  ```bash
21
- # Build the project
22
- npm run build
23
-
24
- # Run in development mode
25
- npm run dev
8
+ # 1. Fork and clone
9
+ git clone https://github.com/YOUR_USERNAME/qdrant-mcp-server.git
10
+ cd qdrant-mcp-server
11
+ npm install
26
12
 
27
- # Run tests
28
- npm test
13
+ # 2. Create feature branch
14
+ git checkout -b feat/your-feature-name
29
15
 
30
- # Run tests with UI
31
- npm run test:ui
16
+ # 3. Make changes, add tests
32
17
 
33
- # Run tests with coverage
34
- npm run test:coverage
35
-
36
- # Run provider verification tests
37
- npm run test:providers
38
-
39
- # Type check
18
+ # 4. Verify
19
+ npm test -- --run
40
20
  npm run type-check
21
+ npm run build
22
+
23
+ # 5. Commit with conventional format
24
+ git commit -m "feat: add new feature"
41
25
  ```
42
26
 
43
- ### Making Changes
27
+ ## Development Commands
44
28
 
45
- 1. Make your changes in your feature branch
46
- 2. Add tests for your changes
47
- 3. Ensure all tests pass: `npm test -- --run`
48
- 4. Ensure type checking passes: `npm run type-check`
49
- 5. Build the project: `npm run build`
50
- 6. Commit your changes using conventional commits (see below)
29
+ | Command | Purpose |
30
+ | ------------------------ | ---------------------------- |
31
+ | `npm run build` | Build for production |
32
+ | `npm run dev` | Development with auto-reload |
33
+ | `npm test` | Run test suite |
34
+ | `npm run test:ui` | Tests with UI |
35
+ | `npm run test:coverage` | Coverage report |
36
+ | `npm run test:providers` | Provider verification |
37
+ | `npm run type-check` | TypeScript validation |
51
38
 
52
- ## Commit Message Convention
39
+ ## Commit Convention
53
40
 
54
- This project uses [Conventional Commits](https://www.conventionalcommits.org/) for commit messages. This enables automated versioning and changelog generation.
41
+ This project uses [Conventional Commits](https://www.conventionalcommits.org/) for automated versioning and releases.
55
42
 
56
- ### Commit Message Format
43
+ ### Format
57
44
 
58
45
  ```
59
46
  <type>(<scope>): <subject>
@@ -63,34 +50,37 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org/) f
63
50
  <footer>
64
51
  ```
65
52
 
66
- ### Commit Types
53
+ ### Types
67
54
 
68
- - **feat**: A new feature (triggers minor version bump)
69
- - **fix**: A bug fix (triggers patch version bump)
70
- - **docs**: Documentation changes (triggers patch version bump)
71
- - **style**: Code style changes (formatting, missing semicolons, etc.)
72
- - **refactor**: Code refactoring without changing functionality (triggers patch version bump)
73
- - **perf**: Performance improvements (triggers patch version bump)
74
- - **test**: Adding or updating tests
75
- - **chore**: Changes to build process, dependencies, etc.
76
- - **ci**: Changes to CI/CD configuration
77
- - **build**: Changes to build system
55
+ | Type | Description | Version Bump |
56
+ | ---------- | ----------------------- | ------------- |
57
+ | `feat` | New feature | Minor (1.x.0) |
58
+ | `fix` | Bug fix | Patch (1.0.x) |
59
+ | `docs` | Documentation | Patch |
60
+ | `refactor` | Code refactoring | Patch |
61
+ | `perf` | Performance improvement | Patch |
62
+ | `test` | Adding/updating tests | None |
63
+ | `chore` | Build/dependencies | None |
64
+ | `ci` | CI/CD changes | None |
65
+ | `style` | Code style/formatting | None |
78
66
 
79
67
  ### Breaking Changes
80
68
 
81
- For breaking changes, add `BREAKING CHANGE:` in the commit body or footer, or append `!` after the type:
69
+ Add `BREAKING CHANGE:` in body/footer or append `!` after type:
82
70
 
83
- ```
84
- feat!: remove support for Node 16
71
+ ```bash
72
+ feat!: remove Node 16 support
85
73
 
86
74
  BREAKING CHANGE: Node 16 is no longer supported
87
75
  ```
88
76
 
77
+ This triggers a major version bump (x.0.0).
78
+
89
79
  ### Examples
90
80
 
91
81
  ```bash
92
82
  # Feature
93
- feat(embeddings): add support for new embedding provider
83
+ feat(embeddings): add support for new provider
94
84
 
95
85
  # Bug fix
96
86
  fix(search): correct similarity score calculation
@@ -100,77 +90,76 @@ docs: update installation instructions
100
90
 
101
91
  # Breaking change
102
92
  feat!: change collection schema format
103
-
104
- BREAKING CHANGE: collection schema now requires version field
105
93
  ```
106
94
 
107
- ### Commit Message Validation
95
+ ### Validation
108
96
 
109
- Commit messages are validated using commitlint. Invalid commit messages will be rejected. The validation enforces:
97
+ Commitlint enforces:
110
98
 
111
- - Commit message must follow conventional commits format
112
- - Type must be one of: feat, fix, docs, style, refactor, perf, test, chore, ci, build
113
- - Subject must not be empty
114
- - Subject must not end with a period
115
- - Header must not exceed 100 characters
99
+ - Conventional commits format required
100
+ - Valid type required
101
+ - Subject must not be empty or end with period
102
+ - Header max 100 characters
116
103
  - Subject must not start with uppercase
117
104
 
118
105
  ## Pull Request Process
119
106
 
120
- 1. Update the README.md with details of changes if needed
121
- 2. Update tests to cover your changes
122
- 3. Ensure all CI checks pass
123
- 4. Request review from maintainers
124
- 5. Once approved, your PR will be merged
107
+ 1. **Update docs** if needed
108
+ 2. **Add tests** for changes
109
+ 3. **Pass CI checks** (build, type-check, tests)
110
+ 4. **Request review**
111
+ 5. **Merge** after approval
125
112
 
126
113
  ### PR Title
127
114
 
128
- PR titles should also follow conventional commit format:
115
+ Use conventional commit format:
129
116
 
130
117
  ```
131
118
  feat: add new search feature
132
- fix: resolve connection timeout issue
119
+ fix: resolve connection timeout
133
120
  docs: improve setup documentation
134
121
  ```
135
122
 
136
123
  ## Release Process
137
124
 
138
- This project uses [semantic-release](https://semantic-release.gitbook.io/) for automated releases.
125
+ Automated via [semantic-release](https://semantic-release.gitbook.io/):
126
+
127
+ - Releases on merge to `main`
128
+ - Version follows [Semantic Versioning](https://semver.org/)
129
+ - Changelog auto-generated from commits
130
+ - Packages published to npm
139
131
 
140
- - Releases are automatically created when changes are merged to the `main` branch
141
- - Version numbers follow [Semantic Versioning](https://semver.org/)
142
- - Changelog is automatically generated from commit messages
143
- - Packages are automatically published to npm
132
+ ### Version Bumps
144
133
 
145
- ### Version Bumping
134
+ - `feat` → minor (1.x.0)
135
+ - `fix`, `perf`, `docs`, `refactor` → patch (1.0.x)
136
+ - `BREAKING CHANGE` → major (x.0.0)
146
137
 
147
- - `feat` commits → minor version bump (1.x.0)
148
- - `fix`, `perf`, `docs`, `refactor` commits → patch version bump (1.0.x)
149
- - Commits with `BREAKING CHANGE` → major version bump (x.0.0)
138
+ ## Testing
139
+
140
+ - Write tests for all new features and bug fixes
141
+ - Maintain or improve code coverage
142
+ - Run full test suite before submitting PRs
143
+ - Include both unit and integration tests
150
144
 
151
145
  ## Project Structure
152
146
 
153
147
  ```
154
148
  qdrant-mcp-server/
155
149
  ├── src/ # Source code
150
+ │ ├── embeddings/ # Embedding providers
151
+ │ └── qdrant/ # Qdrant client
156
152
  ├── build/ # Compiled output
153
+ ├── examples/ # Usage examples
157
154
  ├── scripts/ # Utility scripts
158
155
  ├── .github/ # GitHub Actions workflows
159
- ├── .husky/ # Git hooks
160
- └── tests/ # Test files
156
+ └── .husky/ # Git hooks
161
157
  ```
162
158
 
163
- ## Testing
164
-
165
- - Write tests for all new features and bug fixes
166
- - Maintain or improve code coverage
167
- - Run the full test suite before submitting PRs
168
- - Include both unit tests and integration tests where appropriate
169
-
170
159
  ## Questions?
171
160
 
172
- If you have questions about contributing, please open an issue for discussion.
161
+ Open an issue for discussion.
173
162
 
174
163
  ## License
175
164
 
176
- By contributing to qdrant-mcp-server, you agree that your contributions will be licensed under the project's MIT License.
165
+ By contributing, you agree your contributions will be licensed under the MIT License.