mcp-remlezrd 0.1.0__tar.gz
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.
- mcp_remlezrd-0.1.0/.gitignore +26 -0
- mcp_remlezrd-0.1.0/LICENSE.md +157 -0
- mcp_remlezrd-0.1.0/PKG-INFO +152 -0
- mcp_remlezrd-0.1.0/README.md +119 -0
- mcp_remlezrd-0.1.0/docs/_policies/configuration.md +99 -0
- mcp_remlezrd-0.1.0/docs/_policies/development-tools.md +105 -0
- mcp_remlezrd-0.1.0/docs/_policies/devops.md +63 -0
- mcp_remlezrd-0.1.0/docs/_policies/doc-as-code.md +94 -0
- mcp_remlezrd-0.1.0/docs/_policies/errors_and_logging.md +159 -0
- mcp_remlezrd-0.1.0/docs/_policies/performance-patterns.md +52 -0
- mcp_remlezrd-0.1.0/docs/_policies/project-dependencies.md +76 -0
- mcp_remlezrd-0.1.0/docs/_policies/python-composition-protocols.md +138 -0
- mcp_remlezrd-0.1.0/docs/_policies/resource-base.md +166 -0
- mcp_remlezrd-0.1.0/docs/assets/avatar_project_512.png +0 -0
- mcp_remlezrd-0.1.0/docs/assets/avatar_project_t512.png +0 -0
- mcp_remlezrd-0.1.0/pyproject.toml +352 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/__init__.py +14 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/bootstrap/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/bootstrap/container.py +127 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/exceptions.py +26 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/onboarding/__init__.py +5 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/onboarding/consts.py +24 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/onboarding/meta.py +9 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/onboarding/schemas.py +36 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/__init__.py +62 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/consts.py +123 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/content_strategy.py +167 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/domain.py +293 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/md_sections.py +243 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/meta.py +20 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/output_schemas.py +52 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/service.py +696 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/adr/service_utils.py +32 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/glossary/__init__.py +60 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/glossary/consts.py +122 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/glossary/content_strategy.py +143 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/glossary/domain.py +197 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/glossary/md_sections.py +172 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/glossary/meta.py +20 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/glossary/output_schemas.py +50 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/glossary/service.py +423 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/project/meta.py +9 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/meta.py +9 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/rule/__init__.py +77 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/rule/consts.py +134 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/rule/content_strategy.py +113 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/rule/domain.py +126 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/rule/md_sections.py +100 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/rule/meta.py +20 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/rule/output_schemas.py +47 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/rule/service.py +446 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/skill/__init__.py +70 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/skill/consts.py +134 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/skill/content_strategy.py +128 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/skill/domain.py +183 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/skill/md_sections.py +219 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/skill/meta.py +20 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/skill/output_schemas.py +48 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shareable/skill/service.py +462 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/app_meta.py +9 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/consts.py +5 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/domain.py +356 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/exceptions.py +23 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/markdown/__init__.py +33 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/markdown/extractors.py +110 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/markdown/iterators.py +107 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/markdown/normalized_renderer.py +39 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/markdown/renderers.py +23 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/markdown/validators.py +46 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/md_sections.py +454 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/meta_types.py +40 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/ports.py +48 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/services.py +464 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/features/shared/services_utils.py +74 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/__init__.py +7 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/config/__init__.py +11 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/config/args.py +26 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/config/settings.py +399 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/cli/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/cli/main.py +411 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/__init__.py +4 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/formatters/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/formatters/descriptions.py +193 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/formatters/results.py +74 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/middleware_connection.py +58 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/onboarding/__init__.py +0 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/onboarding/onboarding.py +132 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/project/__init__.py +27 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/project/adr.py +257 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/project/glossary.py +236 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/shareable/__init__.py +27 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/shareable/rule.py +268 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/entrypoints/fastmcp/shareable/skill.py +283 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/external/file_watcher.py +291 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/logging/__init__.py +5 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/logging/logging.py +23 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/persistence/__init__.py +8 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/persistence/db_manager.py +46 -0
- mcp_remlezrd-0.1.0/src/mcp_remlezrd/infra/persistence/files.py +250 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# hidden directories ------------------
|
|
2
|
+
/.*/
|
|
3
|
+
!/.taskfile.d/
|
|
4
|
+
|
|
5
|
+
# Cache and Working files -------------
|
|
6
|
+
__pycache__/
|
|
7
|
+
*.py[oc]
|
|
8
|
+
WIP*
|
|
9
|
+
*.tmp
|
|
10
|
+
.codebook.toml
|
|
11
|
+
/*.ods
|
|
12
|
+
/*.csv
|
|
13
|
+
/.taskfile.d/uv/ci_quality_job.sh
|
|
14
|
+
*merge_codeclimate.py
|
|
15
|
+
|
|
16
|
+
# Deliverables ------------------------
|
|
17
|
+
/dist/
|
|
18
|
+
|
|
19
|
+
# docs --------------------------------
|
|
20
|
+
/docs/_meta/
|
|
21
|
+
/docs/_ideas
|
|
22
|
+
docs/help/
|
|
23
|
+
docs/_adrs/
|
|
24
|
+
docs/_glossary/
|
|
25
|
+
docs/_skills/
|
|
26
|
+
docs/_rules/
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# GNU LESSER GENERAL PUBLIC LICENSE
|
|
2
|
+
|
|
3
|
+
Version 3, 29 June 2007
|
|
4
|
+
|
|
5
|
+
Copyright (C) 2007 Free Software Foundation, Inc.
|
|
6
|
+
<https://fsf.org/>
|
|
7
|
+
|
|
8
|
+
Everyone is permitted to copy and distribute verbatim copies of this
|
|
9
|
+
license document, but changing it is not allowed.
|
|
10
|
+
|
|
11
|
+
This version of the GNU Lesser General Public License incorporates the
|
|
12
|
+
terms and conditions of version 3 of the GNU General Public License,
|
|
13
|
+
supplemented by the additional permissions listed below.
|
|
14
|
+
|
|
15
|
+
## 0. Additional Definitions.
|
|
16
|
+
|
|
17
|
+
As used herein, "this License" refers to version 3 of the GNU Lesser
|
|
18
|
+
General Public License, and the "GNU GPL" refers to version 3 of the
|
|
19
|
+
GNU General Public License.
|
|
20
|
+
|
|
21
|
+
"The Library" refers to a covered work governed by this License, other
|
|
22
|
+
than an Application or a Combined Work as defined below.
|
|
23
|
+
|
|
24
|
+
An "Application" is any work that makes use of an interface provided
|
|
25
|
+
by the Library, but which is not otherwise based on the Library.
|
|
26
|
+
Defining a subclass of a class defined by the Library is deemed a mode
|
|
27
|
+
of using an interface provided by the Library.
|
|
28
|
+
|
|
29
|
+
A "Combined Work" is a work produced by combining or linking an
|
|
30
|
+
Application with the Library. The particular version of the Library
|
|
31
|
+
with which the Combined Work was made is also called the "Linked
|
|
32
|
+
Version".
|
|
33
|
+
|
|
34
|
+
The "Minimal Corresponding Source" for a Combined Work means the
|
|
35
|
+
Corresponding Source for the Combined Work, excluding any source code
|
|
36
|
+
for portions of the Combined Work that, considered in isolation, are
|
|
37
|
+
based on the Application, and not on the Linked Version.
|
|
38
|
+
|
|
39
|
+
The "Corresponding Application Code" for a Combined Work means the
|
|
40
|
+
object code and/or source code for the Application, including any data
|
|
41
|
+
and utility programs needed for reproducing the Combined Work from the
|
|
42
|
+
Application, but excluding the System Libraries of the Combined Work.
|
|
43
|
+
|
|
44
|
+
## 1. Exception to Section 3 of the GNU GPL.
|
|
45
|
+
|
|
46
|
+
You may convey a covered work under sections 3 and 4 of this License
|
|
47
|
+
without being bound by section 3 of the GNU GPL.
|
|
48
|
+
|
|
49
|
+
## 2. Conveying Modified Versions.
|
|
50
|
+
|
|
51
|
+
If you modify a copy of the Library, and, in your modifications, a
|
|
52
|
+
facility refers to a function or data to be supplied by an Application
|
|
53
|
+
that uses the facility (other than as an argument passed when the
|
|
54
|
+
facility is invoked), then you may convey a copy of the modified
|
|
55
|
+
version:
|
|
56
|
+
|
|
57
|
+
- a) under this License, provided that you make a good faith effort
|
|
58
|
+
to ensure that, in the event an Application does not supply the
|
|
59
|
+
function or data, the facility still operates, and performs
|
|
60
|
+
whatever part of its purpose remains meaningful, or
|
|
61
|
+
- b) under the GNU GPL, with none of the additional permissions of
|
|
62
|
+
this License applicable to that copy.
|
|
63
|
+
|
|
64
|
+
## 3. Object Code Incorporating Material from Library Header Files.
|
|
65
|
+
|
|
66
|
+
The object code form of an Application may incorporate material from a
|
|
67
|
+
header file that is part of the Library. You may convey such object
|
|
68
|
+
code under terms of your choice, provided that, if the incorporated
|
|
69
|
+
material is not limited to numerical parameters, data structure
|
|
70
|
+
layouts and accessors, or small macros, inline functions and templates
|
|
71
|
+
(ten or fewer lines in length), you do both of the following:
|
|
72
|
+
|
|
73
|
+
- a) Give prominent notice with each copy of the object code that
|
|
74
|
+
the Library is used in it and that the Library and its use are
|
|
75
|
+
covered by this License.
|
|
76
|
+
- b) Accompany the object code with a copy of the GNU GPL and this
|
|
77
|
+
license document.
|
|
78
|
+
|
|
79
|
+
## 4. Combined Works.
|
|
80
|
+
|
|
81
|
+
You may convey a Combined Work under terms of your choice that, taken
|
|
82
|
+
together, effectively do not restrict modification of the portions of
|
|
83
|
+
the Library contained in the Combined Work and reverse engineering for
|
|
84
|
+
debugging such modifications, if you also do each of the following:
|
|
85
|
+
|
|
86
|
+
- a) Give prominent notice with each copy of the Combined Work that
|
|
87
|
+
the Library is used in it and that the Library and its use are
|
|
88
|
+
covered by this License.
|
|
89
|
+
- b) Accompany the Combined Work with a copy of the GNU GPL and this
|
|
90
|
+
license document.
|
|
91
|
+
- c) For a Combined Work that displays copyright notices during
|
|
92
|
+
execution, include the copyright notice for the Library among
|
|
93
|
+
these notices, as well as a reference directing the user to the
|
|
94
|
+
copies of the GNU GPL and this license document.
|
|
95
|
+
- d) Do one of the following:
|
|
96
|
+
- 0) Convey the Minimal Corresponding Source under the terms of
|
|
97
|
+
this License, and the Corresponding Application Code in a form
|
|
98
|
+
suitable for, and under terms that permit, the user to
|
|
99
|
+
recombine or relink the Application with a modified version of
|
|
100
|
+
the Linked Version to produce a modified Combined Work, in the
|
|
101
|
+
manner specified by section 6 of the GNU GPL for conveying
|
|
102
|
+
Corresponding Source.
|
|
103
|
+
- 1) Use a suitable shared library mechanism for linking with
|
|
104
|
+
the Library. A suitable mechanism is one that (a) uses at run
|
|
105
|
+
time a copy of the Library already present on the user's
|
|
106
|
+
computer system, and (b) will operate properly with a modified
|
|
107
|
+
version of the Library that is interface-compatible with the
|
|
108
|
+
Linked Version.
|
|
109
|
+
- e) Provide Installation Information, but only if you would
|
|
110
|
+
otherwise be required to provide such information under section 6
|
|
111
|
+
of the GNU GPL, and only to the extent that such information is
|
|
112
|
+
necessary to install and execute a modified version of the
|
|
113
|
+
Combined Work produced by recombining or relinking the Application
|
|
114
|
+
with a modified version of the Linked Version. (If you use option
|
|
115
|
+
4d0, the Installation Information must accompany the Minimal
|
|
116
|
+
Corresponding Source and Corresponding Application Code. If you
|
|
117
|
+
use option 4d1, you must provide the Installation Information in
|
|
118
|
+
the manner specified by section 6 of the GNU GPL for conveying
|
|
119
|
+
Corresponding Source.)
|
|
120
|
+
|
|
121
|
+
## 5. Combined Libraries.
|
|
122
|
+
|
|
123
|
+
You may place library facilities that are a work based on the Library
|
|
124
|
+
side by side in a single library together with other library
|
|
125
|
+
facilities that are not Applications and are not covered by this
|
|
126
|
+
License, and convey such a combined library under terms of your
|
|
127
|
+
choice, if you do both of the following:
|
|
128
|
+
|
|
129
|
+
- a) Accompany the combined library with a copy of the same work
|
|
130
|
+
based on the Library, uncombined with any other library
|
|
131
|
+
facilities, conveyed under the terms of this License.
|
|
132
|
+
- b) Give prominent notice with the combined library that part of it
|
|
133
|
+
is a work based on the Library, and explaining where to find the
|
|
134
|
+
accompanying uncombined form of the same work.
|
|
135
|
+
|
|
136
|
+
## 6. Revised Versions of the GNU Lesser General Public License.
|
|
137
|
+
|
|
138
|
+
The Free Software Foundation may publish revised and/or new versions
|
|
139
|
+
of the GNU Lesser General Public License from time to time. Such new
|
|
140
|
+
versions will be similar in spirit to the present version, but may
|
|
141
|
+
differ in detail to address new problems or concerns.
|
|
142
|
+
|
|
143
|
+
Each version is given a distinguishing version number. If the Library
|
|
144
|
+
as you received it specifies that a certain numbered version of the
|
|
145
|
+
GNU Lesser General Public License "or any later version" applies to
|
|
146
|
+
it, you have the option of following the terms and conditions either
|
|
147
|
+
of that published version or of any later version published by the
|
|
148
|
+
Free Software Foundation. If the Library as you received it does not
|
|
149
|
+
specify a version number of the GNU Lesser General Public License, you
|
|
150
|
+
may choose any version of the GNU Lesser General Public License ever
|
|
151
|
+
published by the Free Software Foundation.
|
|
152
|
+
|
|
153
|
+
If the Library as you received it specifies that a proxy can decide
|
|
154
|
+
whether future versions of the GNU Lesser General Public License shall
|
|
155
|
+
apply, that proxy's public statement of acceptance of any version is
|
|
156
|
+
permanent authorization for you to choose that version for the
|
|
157
|
+
Library.
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mcp-remlezrd
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Model Context Protocol (MCP) server for AI agents
|
|
5
|
+
Project-URL: Documentation, https://gitlab.com/gp3t1/ai/mcp-remlezrd/-/blob/main/README.md
|
|
6
|
+
Project-URL: Homepage, https://gitlab.com/gp3t1/ai/mcp-remlezrd
|
|
7
|
+
Project-URL: Issues, https://gitlab.com/gp3t1/ai/mcp-remlezrd/-/issues
|
|
8
|
+
Project-URL: Repository, https://gitlab.com/gp3t1/ai/mcp-remlezrd
|
|
9
|
+
Author-email: gp3t1 <jeremy.petit@gmail.com>
|
|
10
|
+
Maintainer-email: gp3t1 <jeremy.petit@gmail.com>
|
|
11
|
+
License-File: LICENSE.md
|
|
12
|
+
Keywords: ai,context,mcp,server
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Environment :: Console
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Requires-Python: >=3.13
|
|
18
|
+
Requires-Dist: dependency-injector[pydantic2]>=4.48.3
|
|
19
|
+
Requires-Dist: fastmcp>=3.2.4
|
|
20
|
+
Requires-Dist: marko>=2.2.2
|
|
21
|
+
Requires-Dist: mcp[cli]>=1.16.0
|
|
22
|
+
Requires-Dist: pydantic
|
|
23
|
+
Requires-Dist: pydantic-settings>=2.13.1
|
|
24
|
+
Requires-Dist: python-frontmatter>=1.1.0
|
|
25
|
+
Requires-Dist: python-json-logger>=4.1.0
|
|
26
|
+
Requires-Dist: pyyaml>=6.0.3
|
|
27
|
+
Requires-Dist: sqlalchemy>=2.0.48
|
|
28
|
+
Requires-Dist: sqlmodel
|
|
29
|
+
Requires-Dist: tiktoken>=0.12.0
|
|
30
|
+
Requires-Dist: typer
|
|
31
|
+
Requires-Dist: watchfiles>=1.1.1
|
|
32
|
+
Description-Content-Type: text/markdown
|
|
33
|
+
|
|
34
|
+
# mcp-remlezrd
|
|
35
|
+
|
|
36
|
+
[](https://www.python.org/)
|
|
37
|
+
[](https://github.com/astral-sh/uv)
|
|
38
|
+
[](https://gitlab.com/gp3t1/ai/mcp-remlezrd/-/releases/permalink/latest)
|
|
39
|
+
[](https://gitlab.com/gp3t1/ai/mcp-remlezrd)
|
|
40
|
+
[](https://gitlab.com/gp3t1/ai/mcp-remlezrd/-/blob/master/LICENSE.md)
|
|
41
|
+
|
|
42
|
+
MCP server for AI agent collaboration through structured, shareable resources.
|
|
43
|
+
|
|
44
|
+
## Features
|
|
45
|
+
|
|
46
|
+
### 1. Agent Autonomy for Context Loading
|
|
47
|
+
|
|
48
|
+
The server empowers AI agents to self-discover and load team standards (development, design,
|
|
49
|
+
architecture, etc.) without hard-coding context:
|
|
50
|
+
|
|
51
|
+
- **Discovery tools** — Provide a searchable index of all project and shared standards so the agent
|
|
52
|
+
knows what resources exist before reading them.
|
|
53
|
+
- **Native MCP resources** — Standards are exposed as MCP resources in Markdown format, directly
|
|
54
|
+
accessible by the client.
|
|
55
|
+
- **Tool fallback** — If the MCP client does not support resources, the same content is available
|
|
56
|
+
via dedicated read tools.
|
|
57
|
+
|
|
58
|
+
### 2. (Agent|Human)-Friendly Workflow
|
|
59
|
+
|
|
60
|
+
Designed for collaboration between developers and AI agents:
|
|
61
|
+
|
|
62
|
+
- **Human-first editing** — All resources are plain Markdown files with YAML frontmatter. Developers
|
|
63
|
+
can read, edit, and version them with standard tools.
|
|
64
|
+
- **Agent consumption** — Agents read resources natively via MCP (or through tools when resource
|
|
65
|
+
support is absent).
|
|
66
|
+
- **Agent-assisted maintenance** — Agents can create, update, and delete standards through CRUD
|
|
67
|
+
tools, keeping conventions alive without manual boilerplate.
|
|
68
|
+
|
|
69
|
+
### 3. Modular Standards, Universal Access
|
|
70
|
+
|
|
71
|
+
- **Specialized resources** — Standards, procedures, and knowledge are stored in dedicated,
|
|
72
|
+
maintainable files instead of monolithic `README.md` or `AGENTS.md` .
|
|
73
|
+
- **Universal format** — Uses the MCP protocol, avoiding IDE-specific formats such as `.cursorrules`
|
|
74
|
+
, `.windsurfrules` , or `CLAUDE.md` .
|
|
75
|
+
|
|
76
|
+
### 4. Project-Only Resources (scoped to `cwd`)
|
|
77
|
+
|
|
78
|
+
| Resource | Status | Description |
|
|
79
|
+
|---|---|---|
|
|
80
|
+
| **ADR** | `experiment` | Architecture Decision Records — capture technical choices, trade-offs, and their rationale. |
|
|
81
|
+
| **Glossary** | `experiment` | Term definitions and domain vocabulary — ensure consistent language across the team. |
|
|
82
|
+
|
|
83
|
+
### 5. Shareable Resources (external directory)
|
|
84
|
+
|
|
85
|
+
| Resource | Status | Description |
|
|
86
|
+
|---|---|---|
|
|
87
|
+
| **Rule** | `experiment` | Coding standards and constraints — enforceable guidelines for agent behavior. |
|
|
88
|
+
| **Skill** | `experiment` | Actionable procedures and how-to guides — step-by-step recipes for common tasks. |
|
|
89
|
+
|
|
90
|
+
## Getting Started
|
|
91
|
+
|
|
92
|
+
### Starting RemLezrd MCP Server
|
|
93
|
+
|
|
94
|
+
Run with default settings:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
uv run mcp-remlezrd
|
|
98
|
+
uv run mcp-remlezrd --no-shared
|
|
99
|
+
uv run mcp-remlezrd --disable-resources skill,glossary
|
|
100
|
+
uv run mcp-remlezrd --no-write-servers project,shareable
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Run with custom paths and logging:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
uv run mcp-remlezrd --log-file /tmp/remlezrd.log
|
|
107
|
+
uv run mcp-remlezrd --no-write-resources rule,skill --resource-as-tool
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
> **NOTE:** `--shared` controls whether the shared directory is mounted at startup (a physical
|
|
111
|
+
> storage concern). Use `--disable-servers`, `--disable-resources`, `--no-write-servers`, or
|
|
112
|
+
> `--no-write-resources` to control which MCP components are exposed and their access mode
|
|
113
|
+
> (read-write vs read-only). These are independent mechanisms.
|
|
114
|
+
|
|
115
|
+
### Configure MCP Clients (IDE, Agents, etc)
|
|
116
|
+
|
|
117
|
+
TODO
|
|
118
|
+
|
|
119
|
+
### CLI Options and environment variables
|
|
120
|
+
|
|
121
|
+
```txt
|
|
122
|
+
Usage: mcp-remlezrd [OPTIONS]
|
|
123
|
+
|
|
124
|
+
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
125
|
+
│ --shared --no-shared Enable/disable shared directory (Disable to use project-only mode) │
|
|
126
|
+
│ [env var: REMLEZRD_ENABLE_SHARED_DIR] │
|
|
127
|
+
│ [default: shared] │
|
|
128
|
+
│ --resource-as-tool --no-resource-as-tool Only for CLIENT with NO 'MCP Resources' Support │
|
|
129
|
+
│ [env var: REMLEZRD_RESOURCES_AS_TOOLS] │
|
|
130
|
+
│ [default: no-resource-as-tool] │
|
|
131
|
+
│ --log-file PATH Path to log file [env var: REMLEZRD_LOG_FILE] │
|
|
132
|
+
│ --help Show this message and exit. │
|
|
133
|
+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
134
|
+
╭─ Options: RemLezrd Features Activation (support comma-separated lists) ──────────────────────────────────────────────────────────────────╮
|
|
135
|
+
│ --disable-servers [project|shareable|onboarding] List of servers to disable [env var: REMLEZRD_DISABLE_SERVERS] │
|
|
136
|
+
│ --no-write-servers [project|shareable|onboarding] List of servers to disable RW tools from │
|
|
137
|
+
│ [env var: REMLEZRD_NO_WRITE_SERVERS] │
|
|
138
|
+
│ --disable-resources [adr|glossary|rule|skill] List of resource types to disable [env var: REMLEZRD_DISABLE_RESOURCES] │
|
|
139
|
+
│ --no-write-resources [adr|glossary|rule|skill] List of resource types to disable RW tools from │
|
|
140
|
+
│ [env var: REMLEZRD_NO_WRITE_RESOURCES] │
|
|
141
|
+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
142
|
+
|
|
143
|
+
Other Environment Variables:
|
|
144
|
+
🔹 Console handler log level [env var: REMLEZRD_LOG_LEVEL] [default: 'WARNING']
|
|
145
|
+
🔹 File handler log level [env var: REMLEZRD_LOG_FILE_LEVEL] [default: 'INFO']
|
|
146
|
+
🔹 Abs. path to Project dir [env var: REMLEZRD_OVERRIDE_CWD] [default: '<cwd>']
|
|
147
|
+
🔹 Abs. path to Shared dir [env var: REMLEZRD_SHARED_DIR] [default: '~/.local/share/remlezrd']
|
|
148
|
+
🔹 Subdir for ADRs [env var: REMLEZRD_SUBDIR_ADR] [default: 'docs/_adrs']
|
|
149
|
+
🔹 Subdir for Glossaries [env var: REMLEZRD_SUBDIR_GLOSSARY] [default: 'docs/_glossary']
|
|
150
|
+
🔹 Subdir for Rules [env var: REMLEZRD_SUBDIR_RULE] [default: 'docs/_rules']
|
|
151
|
+
🔹 Subdir for Skills [env var: REMLEZRD_SUBDIR_SKILL] [default: 'docs/_skills']
|
|
152
|
+
```
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# mcp-remlezrd
|
|
2
|
+
|
|
3
|
+
[](https://www.python.org/)
|
|
4
|
+
[](https://github.com/astral-sh/uv)
|
|
5
|
+
[](https://gitlab.com/gp3t1/ai/mcp-remlezrd/-/releases/permalink/latest)
|
|
6
|
+
[](https://gitlab.com/gp3t1/ai/mcp-remlezrd)
|
|
7
|
+
[](https://gitlab.com/gp3t1/ai/mcp-remlezrd/-/blob/master/LICENSE.md)
|
|
8
|
+
|
|
9
|
+
MCP server for AI agent collaboration through structured, shareable resources.
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
### 1. Agent Autonomy for Context Loading
|
|
14
|
+
|
|
15
|
+
The server empowers AI agents to self-discover and load team standards (development, design,
|
|
16
|
+
architecture, etc.) without hard-coding context:
|
|
17
|
+
|
|
18
|
+
- **Discovery tools** — Provide a searchable index of all project and shared standards so the agent
|
|
19
|
+
knows what resources exist before reading them.
|
|
20
|
+
- **Native MCP resources** — Standards are exposed as MCP resources in Markdown format, directly
|
|
21
|
+
accessible by the client.
|
|
22
|
+
- **Tool fallback** — If the MCP client does not support resources, the same content is available
|
|
23
|
+
via dedicated read tools.
|
|
24
|
+
|
|
25
|
+
### 2. (Agent|Human)-Friendly Workflow
|
|
26
|
+
|
|
27
|
+
Designed for collaboration between developers and AI agents:
|
|
28
|
+
|
|
29
|
+
- **Human-first editing** — All resources are plain Markdown files with YAML frontmatter. Developers
|
|
30
|
+
can read, edit, and version them with standard tools.
|
|
31
|
+
- **Agent consumption** — Agents read resources natively via MCP (or through tools when resource
|
|
32
|
+
support is absent).
|
|
33
|
+
- **Agent-assisted maintenance** — Agents can create, update, and delete standards through CRUD
|
|
34
|
+
tools, keeping conventions alive without manual boilerplate.
|
|
35
|
+
|
|
36
|
+
### 3. Modular Standards, Universal Access
|
|
37
|
+
|
|
38
|
+
- **Specialized resources** — Standards, procedures, and knowledge are stored in dedicated,
|
|
39
|
+
maintainable files instead of monolithic `README.md` or `AGENTS.md` .
|
|
40
|
+
- **Universal format** — Uses the MCP protocol, avoiding IDE-specific formats such as `.cursorrules`
|
|
41
|
+
, `.windsurfrules` , or `CLAUDE.md` .
|
|
42
|
+
|
|
43
|
+
### 4. Project-Only Resources (scoped to `cwd`)
|
|
44
|
+
|
|
45
|
+
| Resource | Status | Description |
|
|
46
|
+
|---|---|---|
|
|
47
|
+
| **ADR** | `experiment` | Architecture Decision Records — capture technical choices, trade-offs, and their rationale. |
|
|
48
|
+
| **Glossary** | `experiment` | Term definitions and domain vocabulary — ensure consistent language across the team. |
|
|
49
|
+
|
|
50
|
+
### 5. Shareable Resources (external directory)
|
|
51
|
+
|
|
52
|
+
| Resource | Status | Description |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| **Rule** | `experiment` | Coding standards and constraints — enforceable guidelines for agent behavior. |
|
|
55
|
+
| **Skill** | `experiment` | Actionable procedures and how-to guides — step-by-step recipes for common tasks. |
|
|
56
|
+
|
|
57
|
+
## Getting Started
|
|
58
|
+
|
|
59
|
+
### Starting RemLezrd MCP Server
|
|
60
|
+
|
|
61
|
+
Run with default settings:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
uv run mcp-remlezrd
|
|
65
|
+
uv run mcp-remlezrd --no-shared
|
|
66
|
+
uv run mcp-remlezrd --disable-resources skill,glossary
|
|
67
|
+
uv run mcp-remlezrd --no-write-servers project,shareable
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Run with custom paths and logging:
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
uv run mcp-remlezrd --log-file /tmp/remlezrd.log
|
|
74
|
+
uv run mcp-remlezrd --no-write-resources rule,skill --resource-as-tool
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
> **NOTE:** `--shared` controls whether the shared directory is mounted at startup (a physical
|
|
78
|
+
> storage concern). Use `--disable-servers`, `--disable-resources`, `--no-write-servers`, or
|
|
79
|
+
> `--no-write-resources` to control which MCP components are exposed and their access mode
|
|
80
|
+
> (read-write vs read-only). These are independent mechanisms.
|
|
81
|
+
|
|
82
|
+
### Configure MCP Clients (IDE, Agents, etc)
|
|
83
|
+
|
|
84
|
+
TODO
|
|
85
|
+
|
|
86
|
+
### CLI Options and environment variables
|
|
87
|
+
|
|
88
|
+
```txt
|
|
89
|
+
Usage: mcp-remlezrd [OPTIONS]
|
|
90
|
+
|
|
91
|
+
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
92
|
+
│ --shared --no-shared Enable/disable shared directory (Disable to use project-only mode) │
|
|
93
|
+
│ [env var: REMLEZRD_ENABLE_SHARED_DIR] │
|
|
94
|
+
│ [default: shared] │
|
|
95
|
+
│ --resource-as-tool --no-resource-as-tool Only for CLIENT with NO 'MCP Resources' Support │
|
|
96
|
+
│ [env var: REMLEZRD_RESOURCES_AS_TOOLS] │
|
|
97
|
+
│ [default: no-resource-as-tool] │
|
|
98
|
+
│ --log-file PATH Path to log file [env var: REMLEZRD_LOG_FILE] │
|
|
99
|
+
│ --help Show this message and exit. │
|
|
100
|
+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
101
|
+
╭─ Options: RemLezrd Features Activation (support comma-separated lists) ──────────────────────────────────────────────────────────────────╮
|
|
102
|
+
│ --disable-servers [project|shareable|onboarding] List of servers to disable [env var: REMLEZRD_DISABLE_SERVERS] │
|
|
103
|
+
│ --no-write-servers [project|shareable|onboarding] List of servers to disable RW tools from │
|
|
104
|
+
│ [env var: REMLEZRD_NO_WRITE_SERVERS] │
|
|
105
|
+
│ --disable-resources [adr|glossary|rule|skill] List of resource types to disable [env var: REMLEZRD_DISABLE_RESOURCES] │
|
|
106
|
+
│ --no-write-resources [adr|glossary|rule|skill] List of resource types to disable RW tools from │
|
|
107
|
+
│ [env var: REMLEZRD_NO_WRITE_RESOURCES] │
|
|
108
|
+
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
109
|
+
|
|
110
|
+
Other Environment Variables:
|
|
111
|
+
🔹 Console handler log level [env var: REMLEZRD_LOG_LEVEL] [default: 'WARNING']
|
|
112
|
+
🔹 File handler log level [env var: REMLEZRD_LOG_FILE_LEVEL] [default: 'INFO']
|
|
113
|
+
🔹 Abs. path to Project dir [env var: REMLEZRD_OVERRIDE_CWD] [default: '<cwd>']
|
|
114
|
+
🔹 Abs. path to Shared dir [env var: REMLEZRD_SHARED_DIR] [default: '~/.local/share/remlezrd']
|
|
115
|
+
🔹 Subdir for ADRs [env var: REMLEZRD_SUBDIR_ADR] [default: 'docs/_adrs']
|
|
116
|
+
🔹 Subdir for Glossaries [env var: REMLEZRD_SUBDIR_GLOSSARY] [default: 'docs/_glossary']
|
|
117
|
+
🔹 Subdir for Rules [env var: REMLEZRD_SUBDIR_RULE] [default: 'docs/_rules']
|
|
118
|
+
🔹 Subdir for Skills [env var: REMLEZRD_SUBDIR_SKILL] [default: 'docs/_skills']
|
|
119
|
+
```
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
---
|
|
2
|
+
created_at: '2025-11-13'
|
|
3
|
+
status: enforced
|
|
4
|
+
tags:
|
|
5
|
+
- configuration
|
|
6
|
+
- cli
|
|
7
|
+
- environment
|
|
8
|
+
- storage
|
|
9
|
+
- logging
|
|
10
|
+
name: "configuration"
|
|
11
|
+
description: "Configuration management policy"
|
|
12
|
+
updated_at: '2025-11-13'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Purpose
|
|
16
|
+
|
|
17
|
+
This policy establishes standardized configuration management patterns to ensure consistent,
|
|
18
|
+
predictable, and maintainable application configuration across all deployment environments. It
|
|
19
|
+
prevents configuration drift, reduces deployment errors, and improves troubleshooting capabilities.
|
|
20
|
+
|
|
21
|
+
## Principles
|
|
22
|
+
|
|
23
|
+
- **Precedence Clarity**: Clear hierarchy for configuration source priority
|
|
24
|
+
- **Environment Parity**: Same configuration mechanisms across all environments
|
|
25
|
+
- **Discoverability**: All configuration options must be documented and accessible
|
|
26
|
+
- **Security**: Sensitive configuration handled through secure channels
|
|
27
|
+
- **Flexibility**: Support for both development and production deployment patterns
|
|
28
|
+
|
|
29
|
+
## Rules
|
|
30
|
+
|
|
31
|
+
### Configuration Precedence Order
|
|
32
|
+
|
|
33
|
+
Configuration MUST follow this precedence order (highest to lowest priority):
|
|
34
|
+
|
|
35
|
+
1. **CLI arguments** (highest priority)
|
|
36
|
+
2. **Environment variables** (prefixed `REMLEZRD_`)
|
|
37
|
+
3. **Default values** (defined in Pydantic model, lowest priority)
|
|
38
|
+
|
|
39
|
+
### CLI Argument Conventions
|
|
40
|
+
|
|
41
|
+
- **All CLI arguments MUST use kebab-case** (e.g., `--my-param`, `--custom-dir`)
|
|
42
|
+
- **Arguments MUST have both short and long forms** where appropriate
|
|
43
|
+
- **Help text MUST be descriptive** and include default values
|
|
44
|
+
- **Boolean flags MUST use --flag/--no-flag pattern** as provided natively by Typer
|
|
45
|
+
|
|
46
|
+
### Environment Variable Conventions
|
|
47
|
+
|
|
48
|
+
- **All environment variables MUST be prefixed with `REMLEZRD_`**
|
|
49
|
+
- **Variable names MUST use UPPER_SNAKE_CASE** after the prefix
|
|
50
|
+
- **Examples**:
|
|
51
|
+
- `REMLEZRD_MY_STORAGE` for `--my-storage` argument
|
|
52
|
+
- `REMLEZRD_PARAM1` for `--param1` argument
|
|
53
|
+
|
|
54
|
+
### Storage Configuration Requirements
|
|
55
|
+
|
|
56
|
+
- **Shared storage path MUST be configurable**
|
|
57
|
+
- **All project storage subdirectories MUST be configurable** relative to CWD
|
|
58
|
+
|
|
59
|
+
### Logging Configuration Requirements
|
|
60
|
+
|
|
61
|
+
- **Log level MUST be configurable** for debugging purposes
|
|
62
|
+
- **Log file path MUST be configurable** for different deployment scenarios
|
|
63
|
+
- **Debug mode MUST enable verbose logging** and framework internals
|
|
64
|
+
- **Production mode MUST use appropriate log levels** for performance
|
|
65
|
+
|
|
66
|
+
### Configuration Exposure Requirements
|
|
67
|
+
|
|
68
|
+
- **Every configuration option MUST be exposed via both CLI argument and environment variable**
|
|
69
|
+
- **Configuration validation MUST occur at startup** with clear error messages
|
|
70
|
+
- **Default values MUST be documented** in help text and configuration schemas
|
|
71
|
+
- **Configuration state MUST be logged** at startup (excluding sensitive values)
|
|
72
|
+
|
|
73
|
+
### Development Tools Configuration
|
|
74
|
+
|
|
75
|
+
- **pyproject.toml SHOULD be used** for centralized configuration of development tools
|
|
76
|
+
- **Global scope**: Configuration precedence and validation patterns apply to all tools
|
|
77
|
+
- **Avoid configuration fragmentation** : Prefer single configuration files over multiple
|
|
78
|
+
tool-specific files
|
|
79
|
+
- **Integration**: Development toolchain configurations follow the same precedence order
|
|
80
|
+
|
|
81
|
+
### Configuration Validation
|
|
82
|
+
|
|
83
|
+
- **Path configurations MUST be validated** for basic accessibility
|
|
84
|
+
- **Invalid configurations MUST provide clear error messages**
|
|
85
|
+
- **Relative paths MUST be resolved consistently**
|
|
86
|
+
- **Environment variable parsing MUST handle basic type conversion**
|
|
87
|
+
|
|
88
|
+
## Exceptions
|
|
89
|
+
|
|
90
|
+
- **Container deployments** may require different default paths with proper documentation
|
|
91
|
+
- **CI/CD environments** may need special configuration handling for ephemeral filesystems
|
|
92
|
+
- **Development setups** may use different default values with proper environment
|
|
93
|
+
detection
|
|
94
|
+
|
|
95
|
+
## References
|
|
96
|
+
|
|
97
|
+
- [Server Configuration Specification](../_specs/infra/configuration.md) - Detailed configuration parameters
|
|
98
|
+
- [Environment Setup Guide](../../README.md#configuration) - User-facing configuration documentation
|
|
99
|
+
- [Pydantic Settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/) - Configuration model implementation
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
---
|
|
2
|
+
created_at: '2025-11-13'
|
|
3
|
+
status: enforced
|
|
4
|
+
tags:
|
|
5
|
+
- development
|
|
6
|
+
- tools
|
|
7
|
+
- ci
|
|
8
|
+
- code-quality
|
|
9
|
+
- debugging
|
|
10
|
+
name: "development-tools"
|
|
11
|
+
description: "Development tools and workflow policy"
|
|
12
|
+
updated_at: '2025-11-13'
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Purpose
|
|
16
|
+
|
|
17
|
+
This policy establishes standardized development toolchain and practices to ensure consistent code
|
|
18
|
+
quality, maintainable build processes, and efficient debugging capabilities across the project. It
|
|
19
|
+
prevents tool fragmentation, reduces onboarding complexity, and maintains uniform development
|
|
20
|
+
experience.
|
|
21
|
+
|
|
22
|
+
## Principles
|
|
23
|
+
|
|
24
|
+
- **Toolchain Consistency** : Same tools and configurations across all development environments
|
|
25
|
+
- **Configuration Centralization**: Single source of truth for tool configurations
|
|
26
|
+
- **Quality Automation**: Automated code formatting, linting, and type checking
|
|
27
|
+
- **Efficient Debugging** : Standardized debugging and inspection tools for development workflow
|
|
28
|
+
- **Build Reproducibility**: Consistent build orchestration and dependency management
|
|
29
|
+
|
|
30
|
+
## Rules
|
|
31
|
+
|
|
32
|
+
### Code Quality Tools
|
|
33
|
+
|
|
34
|
+
- **ruff MUST be used** for both code formatting and linting
|
|
35
|
+
- **Formatting**: Enforce consistent code style automatically
|
|
36
|
+
- **Linting**: Catch code quality issues and potential bugs
|
|
37
|
+
- **Configuration** : `[tool.ruff.format]` and `[tool.ruff.lint]` sections in `pyproject.toml`
|
|
38
|
+
- **Static type checking MUST use one of** (in order of preference):
|
|
39
|
+
- **ty** (preferred) - Fast, modern Python type checker written in Rust
|
|
40
|
+
- **pyrefly** or **basedpyright** - Alternative high-performance type checkers
|
|
41
|
+
- **pyright** - Microsoft's standard Python type checker
|
|
42
|
+
- **Purpose**: Catch type-related errors before runtime
|
|
43
|
+
- **Configuration** : `[tool.ty]` , `[tool.pyrefly]` , `[tool.basedpyright]` , or `[tool.pyright]`
|
|
44
|
+
section in `pyproject.toml`
|
|
45
|
+
|
|
46
|
+
### Testing Framework
|
|
47
|
+
|
|
48
|
+
- **pytest MUST be used** as the primary test engine
|
|
49
|
+
- **Purpose**: Run and validate functionality tests
|
|
50
|
+
- **Configuration**: `[tool.pytest.ini_options]` section in `pyproject.toml`
|
|
51
|
+
- **Integration**: Follow Testing Policy for test strategy and patterns
|
|
52
|
+
|
|
53
|
+
### Package Management
|
|
54
|
+
|
|
55
|
+
- **uv MUST be used** for Python dependency management
|
|
56
|
+
- **Purpose**: Manage dependencies and virtual environments efficiently
|
|
57
|
+
- **Integration** : Tasks in `Taskfile.yml` for dependency operations (e.g., `uv:deps:update` )
|
|
58
|
+
|
|
59
|
+
### Build Orchestration
|
|
60
|
+
|
|
61
|
+
- **Taskfile MUST be used** for build, test, and development task orchestration
|
|
62
|
+
- **Configuration**: `Taskfile.yml` in project root
|
|
63
|
+
- **Purpose**: Provide consistent interface for all development operations
|
|
64
|
+
- **Tasks** : Include standard tasks for build, test, lint, format, and dependency management
|
|
65
|
+
|
|
66
|
+
### Configuration Management
|
|
67
|
+
|
|
68
|
+
- **pyproject.toml MUST be the primary configuration file** for all Python tools
|
|
69
|
+
- **Avoid configuration fragmentation** : Do not create additional config files when
|
|
70
|
+
centralization is possible
|
|
71
|
+
- **Centralization** : All tool configurations (ruff, type checker, pytest, uv) in single file
|
|
72
|
+
- **Consistency**: Standardized configuration patterns across projects
|
|
73
|
+
- **Maintenance**: Single location for tool configuration updates
|
|
74
|
+
|
|
75
|
+
### MCP Debugging Tools
|
|
76
|
+
|
|
77
|
+
- **mcp-inspector SHOULD be integrated** for MCP server debugging and inspection
|
|
78
|
+
- **Purpose**: Real-time monitoring of MCP tools, resources, and interactions
|
|
79
|
+
- **Integration**: `task run:inspector` for piping MCP server output to inspector
|
|
80
|
+
- **Usage**: Development and debugging workflow enhancement
|
|
81
|
+
|
|
82
|
+
### Tool Integration Requirements
|
|
83
|
+
|
|
84
|
+
- **All tools MUST be integrated** into the build pipeline
|
|
85
|
+
- **Configuration consistency MUST be maintained** across development and CI environments
|
|
86
|
+
- **Documentation MUST include** setup instructions for the complete toolchain
|
|
87
|
+
|
|
88
|
+
## Exceptions
|
|
89
|
+
|
|
90
|
+
- **Legacy projects** may maintain existing toolchain until migration is feasible with proper
|
|
91
|
+
documentation
|
|
92
|
+
- **Specialized tools** may be added for specific domains with justification and integration plan
|
|
93
|
+
- **External tool constraints** may require alternative configurations with documented rationale
|
|
94
|
+
|
|
95
|
+
## References
|
|
96
|
+
|
|
97
|
+
- [Configuration Management Policy](./configuration.md) - Configuration precedence and patterns
|
|
98
|
+
- [Testing Policy](./testing.md) - Test strategy and framework integration
|
|
99
|
+
- [ruff Documentation](https://docs.astral.sh/ruff/) - Formatting and linting tool
|
|
100
|
+
- [ty Documentation](https://github.com/astral-sh/ty) - Preferred static type checker
|
|
101
|
+
- [pyrefly Documentation](https://pyrefly.org/) - Alternative static type checker
|
|
102
|
+
- [basedpyright Documentation](https://github.com/detachhead/basedpyright) - Alternative static type checker
|
|
103
|
+
- [pyright Documentation](https://microsoft.github.io/pyright/) - Standard static type checker
|
|
104
|
+
- [pytest Documentation](https://docs.pytest.org/) - Testing framework
|
|
105
|
+
- [Taskfile Documentation](https://taskfile.dev/) - Build orchestration tool
|