@ancientwhispers54/leafengines-mcp-server 1.1.4 → 1.1.6

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 (3) hide show
  1. package/CONTRIBUTING.md +137 -0
  2. package/LICENSE +80 -0
  3. package/package.json +4 -2
@@ -0,0 +1,137 @@
1
+ # Contributing to LeafEngines MCP Server
2
+
3
+ Thank you for your interest in contributing to the LeafEngines MCP Server! This document provides guidelines for contributing to this open-source project.
4
+
5
+ ## 🌱 Project Philosophy
6
+
7
+ This MCP server is a **thin integration adapter** that:
8
+ - Provides protocol handling for the Model Context Protocol
9
+ - Defines tool schemas for agricultural intelligence
10
+ - Forwards requests to the LeafEngines API
11
+ - Contains **NO proprietary algorithms or IP**
12
+
13
+ All proprietary intelligence (TurboQuant, AlphaEarth embeddings, phenology models) remains in the backend API.
14
+
15
+ ## 🚀 Getting Started
16
+
17
+ ### Prerequisites
18
+ - Node.js 18+
19
+ - npm or yarn
20
+ - Git
21
+
22
+ ### Development Setup
23
+ ```bash
24
+ # Clone the repository
25
+ git clone https://github.com/QWarranto/leafengines-claude-mcp.git
26
+ cd leafengines-claude-mcp/leafengines-mcp-server
27
+
28
+ # Install dependencies
29
+ npm install
30
+
31
+ # Build the project
32
+ npm run build
33
+
34
+ # Run development server
35
+ npm run dev
36
+ ```
37
+
38
+ ## 📝 Contribution Guidelines
39
+
40
+ ### 1. Code Style
41
+ - Use TypeScript for all new code
42
+ - Follow existing code patterns and structure
43
+ - Include JSDoc comments for public APIs
44
+ - Run `npm run build` to ensure TypeScript compilation passes
45
+
46
+ ### 2. Pull Request Process
47
+ 1. **Fork the repository**
48
+ 2. **Create a feature branch:** `git checkout -b feature/amazing-feature`
49
+ 3. **Commit your changes:** `git commit -m 'Add some amazing feature'`
50
+ 4. **Push to the branch:** `git push origin feature/amazing-feature`
51
+ 5. **Open a Pull Request**
52
+
53
+ ### 3. What to Contribute
54
+ - **Bug fixes:** Report and fix issues
55
+ - **Documentation:** Improve README, comments, or guides
56
+ - **Tool enhancements:** Add new tool schemas (generic descriptions only)
57
+ - **Protocol improvements:** MCP protocol compliance updates
58
+ - **Testing:** Add unit or integration tests
59
+
60
+ ### 4. What NOT to Contribute
61
+ - **Proprietary algorithms:** Keep all intelligence in the backend API
62
+ - **Specific technical details:** Avoid mentioning "64-dim satellite embeddings", "phenology models", etc.
63
+ - **IP-sensitive code:** This is an adapter-only layer
64
+ - **Hardcoded API logic:** All business logic should remain in the backend
65
+
66
+ ## 🐛 Reporting Issues
67
+
68
+ ### Bug Reports
69
+ When reporting bugs, please include:
70
+ 1. **Environment:** Node.js version, OS, package version
71
+ 2. **Steps to reproduce:** Clear, step-by-step instructions
72
+ 3. **Expected behavior:** What you expected to happen
73
+ 4. **Actual behavior:** What actually happened
74
+ 5. **Logs:** Any error messages or console output
75
+
76
+ ### Feature Requests
77
+ For feature requests:
78
+ 1. **Use case:** Describe the problem you're trying to solve
79
+ 2. **Proposed solution:** How you think it should work
80
+ 3. **Alternatives considered:** Other approaches you've considered
81
+
82
+ ## 🔧 Development Workflow
83
+
84
+ ### Testing
85
+ ```bash
86
+ # Currently no automated tests
87
+ # Manual testing recommended:
88
+ LEAFENGINES_API_KEY="test_key" npm start
89
+ ```
90
+
91
+ ### Building
92
+ ```bash
93
+ npm run build
94
+ ```
95
+
96
+ ### Publishing
97
+ Only maintainers can publish to npm and MCP Registry.
98
+
99
+ ## 📄 License
100
+
101
+ By contributing, you agree that your contributions will be licensed under the Apache 2.0 License. See [LICENSE](LICENSE) for details.
102
+
103
+ ## 🤝 Code of Conduct
104
+
105
+ ### Be Respectful
106
+ - Use welcoming and inclusive language
107
+ - Be respectful of differing viewpoints and experiences
108
+ - Gracefully accept constructive criticism
109
+ - Focus on what is best for the community
110
+
111
+ ### No Harassment
112
+ Harassment of any kind will not be tolerated, including:
113
+ - Offensive comments related to gender, gender identity, sexual orientation, disability, physical appearance, race, religion
114
+ - Sexual images in public spaces
115
+ - Deliberate intimidation, stalking, or following
116
+ - Harassing photography or recording
117
+ - Sustained disruption of discussions
118
+ - Inappropriate physical contact
119
+ - Unwelcome sexual attention
120
+
121
+ ## 🔗 Resources
122
+
123
+ - [GitHub Repository](https://github.com/QWarranto/leafengines-claude-mcp)
124
+ - [npm Package](https://www.npmjs.com/package/@ancientwhispers54/leafengines-mcp-server)
125
+ - [MCP Registry](https://registry.modelcontextprotocol.io)
126
+ - [LeafEngines API Documentation](https://app.soilsidekickpro.com/api-docs)
127
+ - [Model Context Protocol Documentation](https://spec.modelcontextprotocol.io)
128
+
129
+ ## 📞 Getting Help
130
+
131
+ - **GitHub Issues:** For bug reports and feature requests
132
+ - **Pull Requests:** For code contributions
133
+ - **Email:** Contact through GitHub profile
134
+
135
+ ---
136
+
137
+ Thank you for contributing to agricultural AI accessibility! 🌱
package/LICENSE ADDED
@@ -0,0 +1,80 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
10
+
11
+ "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
12
+
13
+ "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
14
+
15
+ "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
16
+
17
+ "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
18
+
19
+ "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
20
+
21
+ "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
22
+
23
+ "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and the Work's Derivative Works.
24
+
25
+ "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
26
+
27
+ "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
28
+
29
+ 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
30
+
31
+ 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
32
+
33
+ 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
34
+
35
+ (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
36
+
37
+ (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
38
+
39
+ (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
40
+
41
+ (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
42
+
43
+ You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
44
+
45
+ 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
46
+
47
+ 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
48
+
49
+ 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
50
+
51
+ 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
52
+
53
+ 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
54
+
55
+ END OF TERMS AND CONDITIONS
56
+
57
+ APPENDIX: How to apply the Apache License to your work.
58
+
59
+ To apply the Apache License to your work, attach the following
60
+ boilerplate notice, with the fields enclosed by brackets "[]"
61
+ replaced with your own identifying information. (Don't include
62
+ the brackets!) The text should be enclosed in the appropriate
63
+ comment syntax for the file format. We also recommend that a
64
+ file or class name and description of purpose be included on the
65
+ same "printed page" as the copyright notice for easier
66
+ identification within third-party archives.
67
+
68
+ Copyright [2026] [QWarranto]
69
+
70
+ Licensed under the Apache License, Version 2.0 (the "License");
71
+ you may not use this file except in compliance with the License.
72
+ You may obtain a copy of the License at
73
+
74
+ http://www.apache.org/licenses/LICENSE-2.0
75
+
76
+ Unless required by applicable law or agreed to in writing, software
77
+ distributed under the License is distributed on an "AS IS" BASIS,
78
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
79
+ See the License for the specific language governing permissions and
80
+ limitations under the License.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ancientwhispers54/leafengines-mcp-server",
3
- "version": "1.1.4",
3
+ "version": "1.1.6",
4
4
  "mcpName": "io.github.QWarranto/leafengines",
5
5
  "description": "Agricultural intelligence MCP server with soil analysis, crop recommendations, weather forecasts, and environmental impact assessment.",
6
6
  "main": "dist/index.js",
@@ -44,6 +44,8 @@
44
44
  },
45
45
  "files": [
46
46
  "dist",
47
- "README.md"
47
+ "README.md",
48
+ "CONTRIBUTING.md",
49
+ "LICENSE"
48
50
  ]
49
51
  }