@shiftleftpt/sbd-toe-mcp 0.1.0
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.
- package/.env.example +35 -0
- package/LICENSE +201 -0
- package/README.md +323 -0
- package/data/publish/algolia_docs_records.json +148847 -0
- package/data/publish/algolia_docs_records_enriched.json +194004 -0
- package/data/publish/algolia_entities_records.json +74715 -0
- package/data/publish/algolia_entities_records_enriched.json +177587 -0
- package/data/publish/algolia_index_settings.json +102 -0
- package/data/publish/sbd-toe-index-compact.json +111 -0
- package/data/reports/run_manifest.json +10 -0
- package/dist/backend/semantic-index-gateway.d.ts +25 -0
- package/dist/backend/semantic-index-gateway.js +555 -0
- package/dist/backend/semantic-index-gateway.js.map +1 -0
- package/dist/backend/semantic-index-gateway.test.d.ts +1 -0
- package/dist/backend/semantic-index-gateway.test.js +384 -0
- package/dist/backend/semantic-index-gateway.test.js.map +1 -0
- package/dist/bootstrap/checkout-backend.d.ts +31 -0
- package/dist/bootstrap/checkout-backend.js +136 -0
- package/dist/bootstrap/checkout-backend.js.map +1 -0
- package/dist/bootstrap/checkout-backend.test.d.ts +1 -0
- package/dist/bootstrap/checkout-backend.test.js +158 -0
- package/dist/bootstrap/checkout-backend.test.js.map +1 -0
- package/dist/bootstrap/release-checkout.d.ts +8 -0
- package/dist/bootstrap/release-checkout.js +168 -0
- package/dist/bootstrap/release-checkout.js.map +1 -0
- package/dist/bootstrap/release-checkout.test.d.ts +1 -0
- package/dist/bootstrap/release-checkout.test.js +137 -0
- package/dist/bootstrap/release-checkout.test.js.map +1 -0
- package/dist/config.d.ts +4 -0
- package/dist/config.js +81 -0
- package/dist/config.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1063 -0
- package/dist/index.js.map +1 -0
- package/dist/orchestrator/ask-manual.d.ts +13 -0
- package/dist/orchestrator/ask-manual.js +202 -0
- package/dist/orchestrator/ask-manual.js.map +1 -0
- package/dist/prompt/build-answer-prompt.d.ts +2 -0
- package/dist/prompt/build-answer-prompt.js +51 -0
- package/dist/prompt/build-answer-prompt.js.map +1 -0
- package/dist/prompt/system-prompt.d.ts +1 -0
- package/dist/prompt/system-prompt.js +94 -0
- package/dist/prompt/system-prompt.js.map +1 -0
- package/dist/resources/sbd-toe-resources.d.ts +18 -0
- package/dist/resources/sbd-toe-resources.js +164 -0
- package/dist/resources/sbd-toe-resources.js.map +1 -0
- package/dist/resources/sbd-toe-resources.test.d.ts +1 -0
- package/dist/resources/sbd-toe-resources.test.js +134 -0
- package/dist/resources/sbd-toe-resources.test.js.map +1 -0
- package/dist/test-utils.d.ts +153 -0
- package/dist/test-utils.js +176 -0
- package/dist/test-utils.js.map +1 -0
- package/dist/tools/generate-document.d.ts +22 -0
- package/dist/tools/generate-document.js +392 -0
- package/dist/tools/generate-document.js.map +1 -0
- package/dist/tools/generate-document.test.d.ts +1 -0
- package/dist/tools/generate-document.test.js +189 -0
- package/dist/tools/generate-document.test.js.map +1 -0
- package/dist/tools/map-review-scope.d.ts +20 -0
- package/dist/tools/map-review-scope.js +299 -0
- package/dist/tools/map-review-scope.js.map +1 -0
- package/dist/tools/map-review-scope.test.d.ts +1 -0
- package/dist/tools/map-review-scope.test.js +204 -0
- package/dist/tools/map-review-scope.test.js.map +1 -0
- package/dist/tools/plan-repo-governance.d.ts +41 -0
- package/dist/tools/plan-repo-governance.js +509 -0
- package/dist/tools/plan-repo-governance.js.map +1 -0
- package/dist/tools/plan-repo-governance.test.d.ts +1 -0
- package/dist/tools/plan-repo-governance.test.js +237 -0
- package/dist/tools/plan-repo-governance.test.js.map +1 -0
- package/dist/tools/structured-tools.d.ts +5 -0
- package/dist/tools/structured-tools.js +310 -0
- package/dist/tools/structured-tools.js.map +1 -0
- package/dist/tools/structured-tools.test.d.ts +1 -0
- package/dist/tools/structured-tools.test.js +459 -0
- package/dist/tools/structured-tools.test.js.map +1 -0
- package/dist/types.d.ts +160 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/dist/upstream/backend-contract.d.ts +3 -0
- package/dist/upstream/backend-contract.js +37 -0
- package/dist/upstream/backend-contract.js.map +1 -0
- package/dist/validators/ai-disclosure.d.ts +39 -0
- package/dist/validators/ai-disclosure.js +183 -0
- package/dist/validators/ai-disclosure.js.map +1 -0
- package/dist/validators/ai-disclosure.test.d.ts +1 -0
- package/dist/validators/ai-disclosure.test.js +244 -0
- package/dist/validators/ai-disclosure.test.js.map +1 -0
- package/examples/claude-desktop.json +8 -0
- package/examples/vscode.mcp.json +9 -0
- package/package.json +50 -0
- package/prompts/sbd-toe-chat-system.md +71 -0
- package/smithery.yaml +44 -0
package/.env.example
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Runtime normal: o bundle local já vem incluído no repositório e nos GitHub Releases.
|
|
2
|
+
# Não é necessário Algolia nem checkout adicional do builder semântico para usar o MCP.
|
|
3
|
+
DOCS_SNAPSHOT_FILE=./data/publish/algolia_docs_records.json
|
|
4
|
+
ENTITIES_SNAPSHOT_FILE=./data/publish/algolia_entities_records.json
|
|
5
|
+
DOCS_ENRICHED_SNAPSHOT_FILE=./data/publish/algolia_docs_records_enriched.json
|
|
6
|
+
ENTITIES_ENRICHED_SNAPSHOT_FILE=./data/publish/algolia_entities_records_enriched.json
|
|
7
|
+
INDEX_SETTINGS_FILE=./data/publish/algolia_index_settings.json
|
|
8
|
+
RUN_MANIFEST_FILE=./data/reports/run_manifest.json
|
|
9
|
+
|
|
10
|
+
# Os dois índices publicados pelo upstream continuam a ser a referência semântica.
|
|
11
|
+
SEMANTIC_BACKEND_DOCS_INDEX=SbD-ToE-ASKAI-Docs
|
|
12
|
+
SEMANTIC_BACKEND_ENTITIES_INDEX=SbD-ToE-ASKAI-Entities
|
|
13
|
+
|
|
14
|
+
# Prompting e links de referência.
|
|
15
|
+
SYSTEM_PROMPT_FILE=./prompts/sbd-toe-chat-system.md
|
|
16
|
+
SITE_BASE_URL=https://www.securitybydesign.dev/
|
|
17
|
+
MANUAL_BASE_URL=https://www.securitybydesign.dev/sbd-toe/sbd-manual/
|
|
18
|
+
CROSS_CHECK_BASE_URL=https://www.securitybydesign.dev/sbd-toe/cross-check-normativo/
|
|
19
|
+
|
|
20
|
+
DEFAULT_LANGUAGE=pt-PT
|
|
21
|
+
DEBUG_MODE=false
|
|
22
|
+
DOCS_HITS=8
|
|
23
|
+
ENTITIES_HITS=5
|
|
24
|
+
MAX_CONTEXT_RECORDS=8
|
|
25
|
+
SAMPLING_MAX_TOKENS=1200
|
|
26
|
+
|
|
27
|
+
# Configuração opcional para mantenedores que queiram atualizar o bundle embutido
|
|
28
|
+
# a partir de um checkout local do repositório sbd-toe-knowledge-graph.
|
|
29
|
+
UPSTREAM_KNOWLEDGE_GRAPH_DIR=../sbd-toe-knowledge-graph
|
|
30
|
+
BACKEND_CHECKOUT_FILE=./data/upstream/backend-checkout.json
|
|
31
|
+
|
|
32
|
+
# Fonte dos snapshots: 'local' (default, cópia da repo local) ou 'release' (GitHub Releases)
|
|
33
|
+
UPSTREAM_SOURCE=local
|
|
34
|
+
# Tag da release a usar (só relevante quando UPSTREAM_SOURCE=release). Use 'latest' para a mais recente.
|
|
35
|
+
UPSTREAM_RELEASE_TAG=latest
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
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,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
# sbd-toe-mcp-poc
|
|
2
|
+
|
|
3
|
+
Servidor MCP (Model Context Protocol) para VS Code, em Node.js/TypeScript, que faz retrieval local sobre snapshots semânticos publicados do manual SbD-ToE e os expõe ao chat via `stdio`.
|
|
4
|
+
|
|
5
|
+
> Estado atual: **PoC / primeira iteração publicável**. O foco desta versão é distribuição simples via GitHub Releases, uso local no VS Code, grounding forte e zero dependência de builder semântico em runtime.
|
|
6
|
+
|
|
7
|
+
## O que é este projeto
|
|
8
|
+
|
|
9
|
+
Este repositório empacota um servidor MCP que:
|
|
10
|
+
|
|
11
|
+
- corre localmente via `stdio`
|
|
12
|
+
- expõe tools e prompts MCP para consulta do manual
|
|
13
|
+
- usa o modelo configurado pelo utilizador no VS Code
|
|
14
|
+
- faz retrieval local sobre um bundle embutido em `data/publish/`
|
|
15
|
+
- devolve contexto grounded, citações e metadados úteis para debug
|
|
16
|
+
|
|
17
|
+
O objetivo é responder melhor, dentro do VS Code, a perguntas práticas sobre o ecossistema SbD-ToE, por exemplo:
|
|
18
|
+
|
|
19
|
+
```text
|
|
20
|
+
quais os requisitos de autenticacao que preciso implementar para esta aplicacao L1
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
ou:
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
Que policies governam pipelines CI/CD?
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Porque existe
|
|
30
|
+
|
|
31
|
+
O manual SbD-ToE é a fonte editorial canónica, mas o consumo prático dentro do editor exige uma camada técnica própria:
|
|
32
|
+
|
|
33
|
+
- descoberta contextual no momento da pergunta
|
|
34
|
+
- recuperação determinística de records relevantes
|
|
35
|
+
- composição de prompt grounded
|
|
36
|
+
- integração direta com o chat do VS Code
|
|
37
|
+
|
|
38
|
+
Este repositório existe para fazer essa ponte, sem duplicar o papel dos outros repositórios do ecossistema.
|
|
39
|
+
|
|
40
|
+
## Relação com o ecossistema SbD-ToE
|
|
41
|
+
|
|
42
|
+
| Repositório | Papel |
|
|
43
|
+
| --- | --- |
|
|
44
|
+
| `Shiftleftpt/SbD-ToE-Manual` | fonte editorial canónica do manual |
|
|
45
|
+
| `sbd-toe-knowledge-graph` | builder/publicador dos snapshots semânticos |
|
|
46
|
+
| `sbd-toe-mcp-poc` | consumer MCP para uso local no VS Code |
|
|
47
|
+
|
|
48
|
+
Este projeto **consome** artefactos já produzidos pelo `sbd-toe-knowledge-graph`. Não reindexa o manual, não reconstrói semântica e não substitui o builder.
|
|
49
|
+
|
|
50
|
+
## O que faz
|
|
51
|
+
|
|
52
|
+
- consulta os snapshots `SbD-ToE-ASKAI-Docs` e `SbD-ToE-ASKAI-Entities`
|
|
53
|
+
- faz ranking local observável para seleção de contexto
|
|
54
|
+
- expõe as tools `search_sbd_toe_manual`, `answer_sbd_toe_manual` e `inspect_sbd_toe_retrieval`
|
|
55
|
+
- expõe a prompt MCP `ask_sbd_toe_manual`
|
|
56
|
+
- permite debug forte quando `debug=true` ou `DEBUG_MODE=true`
|
|
57
|
+
- usa sampling MCP opcionalmente, mantendo o modelo do lado do utilizador
|
|
58
|
+
|
|
59
|
+
## O que não faz
|
|
60
|
+
|
|
61
|
+
- não faz parsing do corpus Markdown
|
|
62
|
+
- não reconstrói bundles semânticos
|
|
63
|
+
- não reindexa o manual
|
|
64
|
+
- não depende de Algolia em runtime
|
|
65
|
+
- não executa retrieval remoto
|
|
66
|
+
- não mantém memória conversacional
|
|
67
|
+
- não substitui o VS Code Chat nem o `sbd-toe-knowledge-graph`
|
|
68
|
+
|
|
69
|
+
## Arquitetura resumida
|
|
70
|
+
|
|
71
|
+
1. O utilizador faz uma pergunta no chat do VS Code.
|
|
72
|
+
2. O chat chama `search_sbd_toe_manual` ou `answer_sbd_toe_manual`.
|
|
73
|
+
3. O servidor MCP lê os snapshots locais embutidos em `data/publish/`.
|
|
74
|
+
4. O retrieval combina records documentais e estruturados.
|
|
75
|
+
5. O servidor devolve contexto grounded com citações `[D1]`, `[E1]`, links e debug.
|
|
76
|
+
6. O modelo do utilizador responde com base nesse contexto.
|
|
77
|
+
|
|
78
|
+
O papel detalhado deste repositório está documentado em [`docs/role.md`](docs/role.md).
|
|
79
|
+
|
|
80
|
+
## Ferramentas MCP expostas
|
|
81
|
+
|
|
82
|
+
- `search_sbd_toe_manual`
|
|
83
|
+
- tool principal para o fluxo normal de chat
|
|
84
|
+
- devolve contexto grounded sem obrigar a sampling
|
|
85
|
+
- `answer_sbd_toe_manual`
|
|
86
|
+
- usa retrieval local e pede a resposta final ao modelo do utilizador via MCP sampling
|
|
87
|
+
- `inspect_sbd_toe_retrieval`
|
|
88
|
+
- mostra retrieval, seleção final e prompt montado
|
|
89
|
+
- útil para tuning, grounding e troubleshooting
|
|
90
|
+
- `ask_sbd_toe_manual`
|
|
91
|
+
- prompt MCP/slash command para orientar o chat a usar retrieval antes de responder
|
|
92
|
+
|
|
93
|
+
## Distribuição e release bundle
|
|
94
|
+
|
|
95
|
+
O canal principal de distribuição é **npm** (`sbd-toe-mcp`). O **GitHub Releases** mantém-se como canal secundário — publica um bundle self-contained para instalação em ambientes sem acesso à internet ou sem `npx`.
|
|
96
|
+
|
|
97
|
+
Cada release publica um bundle via GitHub Releases com convenção de nome explícita:
|
|
98
|
+
|
|
99
|
+
- `sbd-toe-mcp-vX.Y.Z-bundle.tar.gz`
|
|
100
|
+
- `sbd-toe-mcp-vX.Y.Z-bundle.zip`
|
|
101
|
+
- `sbd-toe-mcp-vX.Y.Z-bundle.sha256`
|
|
102
|
+
|
|
103
|
+
O bundle inclui:
|
|
104
|
+
|
|
105
|
+
- `dist/`
|
|
106
|
+
- `data/publish/`
|
|
107
|
+
- `data/reports/run_manifest.json`
|
|
108
|
+
- `prompts/`
|
|
109
|
+
- `examples/`
|
|
110
|
+
- `docs/`
|
|
111
|
+
- `.vscode/mcp.json`
|
|
112
|
+
- `.env.example`
|
|
113
|
+
- `README.md`
|
|
114
|
+
- `CONTRIBUTING.md`
|
|
115
|
+
- `CODE_OF_CONDUCT.md`
|
|
116
|
+
- `SECURITY.md`
|
|
117
|
+
- `SUPPORT.md`
|
|
118
|
+
- ficheiros de licença
|
|
119
|
+
|
|
120
|
+
O bundle **não** inclui:
|
|
121
|
+
|
|
122
|
+
- `node_modules`
|
|
123
|
+
- checkout completo do upstream
|
|
124
|
+
- tooling de desenvolvimento desnecessário para runtime
|
|
125
|
+
|
|
126
|
+
## Como os snapshots são distribuídos
|
|
127
|
+
|
|
128
|
+
`data/publish/` é tratado como parte intencional do produto:
|
|
129
|
+
|
|
130
|
+
- fica **versionado no repositório**
|
|
131
|
+
- fica **incluído no artefacto de release**
|
|
132
|
+
- é a base do retrieval local em runtime
|
|
133
|
+
|
|
134
|
+
Isto significa que:
|
|
135
|
+
|
|
136
|
+
- o utilizador **não precisa** de Algolia
|
|
137
|
+
- o utilizador **não precisa** de correr o builder semântico
|
|
138
|
+
- o utilizador **não precisa** de fazer checkout do `sbd-toe-knowledge-graph` para usar o servidor
|
|
139
|
+
|
|
140
|
+
O ficheiro `data/reports/run_manifest.json` mantém a proveniência do snapshot embutido.
|
|
141
|
+
Esse ficheiro deve conter apenas proveniência pública e redistribuível, sem paths absolutos de máquinas locais.
|
|
142
|
+
|
|
143
|
+
## Instalação via GitHub Release (alternativa sem internet)
|
|
144
|
+
|
|
145
|
+
Fluxo para ambientes sem acesso ao npm ou sem `npx`:
|
|
146
|
+
|
|
147
|
+
1. Descarregar o asset `sbd-toe-mcp-vX.Y.Z-bundle.zip` ou `sbd-toe-mcp-vX.Y.Z-bundle.tar.gz` em **GitHub Releases**.
|
|
148
|
+
2. Extrair o archive para um diretório local.
|
|
149
|
+
3. Confirmar que a extração já inclui `dist/` e `data/publish/`.
|
|
150
|
+
4. Copiar `.env.example` para `.env`.
|
|
151
|
+
5. Abrir a pasta extraída no VS Code.
|
|
152
|
+
6. Reutilizar o `.vscode/mcp.json` já incluído no bundle.
|
|
153
|
+
7. Abrir o chat e usar perguntas reais sobre o manual.
|
|
154
|
+
|
|
155
|
+
Exemplo:
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
cp .env.example .env
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Depois de extrair a release, não é necessário correr `npm ci` nem `npm run build`.
|
|
162
|
+
Também não é necessário editar manualmente a configuração MCP se usares a pasta extraída como workspace do VS Code.
|
|
163
|
+
|
|
164
|
+
## Quick Start — instalar via npm
|
|
165
|
+
|
|
166
|
+
[](https://www.npmjs.com/package/@shiftleftpt/sbd-toe-mcp)
|
|
167
|
+
|
|
168
|
+
**Zero configuração obrigatória.** O servidor funciona directamente com `npx`:
|
|
169
|
+
|
|
170
|
+
1. Instalar Node.js ≥ 20.9.0: [nodejs.org/download](https://nodejs.org/download/)
|
|
171
|
+
2. Registar o servidor no teu cliente MCP (exemplo para Claude Code):
|
|
172
|
+
```bash
|
|
173
|
+
claude mcp add sbd-toe -- npx -y @shiftleftpt/sbd-toe-mcp
|
|
174
|
+
```
|
|
175
|
+
3. Usar as tools MCP no Claude Code (ou Claude Desktop, VS Code, Cursor, etc.)
|
|
176
|
+
|
|
177
|
+
Para instruções completas por cliente MCP (Claude Desktop, VS Code, Cursor, Windsurf, Zed),
|
|
178
|
+
consultar [`docs/installation.md`](docs/installation.md).
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
## Instalação a partir do source
|
|
183
|
+
|
|
184
|
+
Se preferires trabalhar a partir do source deste repositório:
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
npm ci
|
|
188
|
+
npm run check
|
|
189
|
+
npm run build
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
O checkout de source já traz `data/publish/` versionado. Portanto, mesmo a partir do source, o uso normal do MCP **não** depende do builder semântico.
|
|
193
|
+
|
|
194
|
+
O script abaixo é apenas para mantenedores que queiram atualizar o bundle embutido a partir de um checkout local do `sbd-toe-knowledge-graph`:
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
npm run checkout:backend
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
Esse fluxo regenera um manifesto local em `data/upstream/backend-checkout.json`, usado apenas para manutenção/debug local e não versionado neste repositório.
|
|
201
|
+
|
|
202
|
+
## Configuração `.env`
|
|
203
|
+
|
|
204
|
+
Copiar `.env.example` para `.env` e ajustar apenas o que fizer sentido para o teu ambiente local.
|
|
205
|
+
|
|
206
|
+
Variáveis mais relevantes para runtime:
|
|
207
|
+
|
|
208
|
+
| Variável | Uso |
|
|
209
|
+
| --- | --- |
|
|
210
|
+
| `DOCS_SNAPSHOT_FILE` | snapshot documental local |
|
|
211
|
+
| `ENTITIES_SNAPSHOT_FILE` | snapshot de entidades local |
|
|
212
|
+
| `INDEX_SETTINGS_FILE` | metadados dos índices publicados |
|
|
213
|
+
| `RUN_MANIFEST_FILE` | proveniência do bundle embutido |
|
|
214
|
+
| `SYSTEM_PROMPT_FILE` | system prompt usada pela tool de answer |
|
|
215
|
+
| `DEBUG_MODE` | ativa debug adicional nas respostas |
|
|
216
|
+
|
|
217
|
+
Variáveis de manutenção opcional:
|
|
218
|
+
|
|
219
|
+
| Variável | Uso |
|
|
220
|
+
| --- | --- |
|
|
221
|
+
| `UPSTREAM_KNOWLEDGE_GRAPH_DIR` | checkout local do `sbd-toe-knowledge-graph` |
|
|
222
|
+
| `BACKEND_CHECKOUT_FILE` | manifesto local do último refresh do bundle; ficheiro de manutenção local, não versionado |
|
|
223
|
+
|
|
224
|
+
Não há API keys obrigatórias neste projeto: o modelo continua a ser o do utilizador no VS Code.
|
|
225
|
+
|
|
226
|
+
## Integração com VS Code
|
|
227
|
+
|
|
228
|
+
O exemplo de configuração está em [`examples/vscode.mcp.json`](examples/vscode.mcp.json).
|
|
229
|
+
|
|
230
|
+
Para o fluxo mais simples via GitHub Release, o bundle já inclui [`.vscode/mcp.json`](.vscode/mcp.json) com este formato:
|
|
231
|
+
|
|
232
|
+
```json
|
|
233
|
+
{
|
|
234
|
+
"servers": {
|
|
235
|
+
"sbdToe": {
|
|
236
|
+
"type": "stdio",
|
|
237
|
+
"command": "node",
|
|
238
|
+
"args": ["${workspaceFolder}/dist/index.js"],
|
|
239
|
+
"envFile": "${workspaceFolder}/.env"
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
Se abrires a pasta extraída no VS Code, `${workspaceFolder}` passa a apontar para esse bundle e o editor pode usar a configuração diretamente.
|
|
246
|
+
|
|
247
|
+
Exemplo realista para um bundle extraído fora do workspace atual:
|
|
248
|
+
|
|
249
|
+
```json
|
|
250
|
+
{
|
|
251
|
+
"servers": {
|
|
252
|
+
"sbdToe": {
|
|
253
|
+
"type": "stdio",
|
|
254
|
+
"command": "node",
|
|
255
|
+
"args": ["/absolute/path/to/sbd-toe-mcp-poc/dist/index.js"],
|
|
256
|
+
"envFile": "/absolute/path/to/sbd-toe-mcp-poc/.env"
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
}
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
Se estiveres a trabalhar diretamente neste repositório, podes adaptar para `${workspaceFolder}`.
|
|
263
|
+
|
|
264
|
+
## Exemplo de uso no chat
|
|
265
|
+
|
|
266
|
+
Perguntas úteis para validar a integração:
|
|
267
|
+
|
|
268
|
+
```text
|
|
269
|
+
quais os requisitos de autenticacao que preciso implementar para esta aplicacao L1
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
```text
|
|
273
|
+
Que policies governam pipelines CI/CD?
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
Comportamento esperado:
|
|
277
|
+
|
|
278
|
+
- o chat usa `search_sbd_toe_manual` ou `answer_sbd_toe_manual`
|
|
279
|
+
- o MCP recupera records relevantes do bundle local
|
|
280
|
+
- a resposta final usa apenas o contexto recuperado
|
|
281
|
+
- a resposta cita records e aponta páginas determinísticas quando existirem
|
|
282
|
+
|
|
283
|
+
## Troubleshooting e debug
|
|
284
|
+
|
|
285
|
+
- Se `dist/` não existir, estás provavelmente num checkout de source sem build concluído.
|
|
286
|
+
- Se `data/publish/` não existir, a instalação está incompleta ou o archive foi extraído incorretamente.
|
|
287
|
+
- Se o cliente MCP não suportar `sampling`, usa `search_sbd_toe_manual` como fluxo principal.
|
|
288
|
+
- Usa `inspect_sbd_toe_retrieval` para ver retrieval, seleção final e prompt montado.
|
|
289
|
+
- Ativa `DEBUG_MODE=true` para anexar metadados de debug à resposta.
|
|
290
|
+
- Se precisares de atualizar o snapshot embutido, usa `npm run checkout:backend` a partir de um checkout local do `sbd-toe-knowledge-graph`.
|
|
291
|
+
|
|
292
|
+
## Contribuição
|
|
293
|
+
|
|
294
|
+
O fluxo de contribuição está em [`CONTRIBUTING.md`](CONTRIBUTING.md).
|
|
295
|
+
|
|
296
|
+
Em resumo:
|
|
297
|
+
|
|
298
|
+
- trunk-based development com `master`
|
|
299
|
+
- branches `feat/`, `fix/`, `docs/`, `chore/` e `hotfix/`
|
|
300
|
+
- validação local com `npm ci`, `npm run check` e `npm run build`
|
|
301
|
+
- teste manual no VS Code antes de abrir PR
|
|
302
|
+
- squash merge para `master`
|
|
303
|
+
- releases por tag `vX.Y.Z`
|
|
304
|
+
|
|
305
|
+
## Próximas iterações
|
|
306
|
+
|
|
307
|
+
Os pontos abertos e candidatos a evolução futura estão em [`NEXT-STEPS.md`](NEXT-STEPS.md), incluindo a hipótese de uma extensão wrapper para publicação no VS Code Marketplace.
|
|
308
|
+
|
|
309
|
+
## Suporte
|
|
310
|
+
|
|
311
|
+
Ver [`SUPPORT.md`](SUPPORT.md).
|
|
312
|
+
|
|
313
|
+
## Segurança
|
|
314
|
+
|
|
315
|
+
Ver [`SECURITY.md`](SECURITY.md). Vulnerabilidades devem ser reportadas em privado por email, nunca por issue público.
|
|
316
|
+
|
|
317
|
+
## Licença
|
|
318
|
+
|
|
319
|
+
Este repositório usa **split licensing**:
|
|
320
|
+
|
|
321
|
+
- código e runtime: [`LICENSE`](LICENSE) (`Apache-2.0`)
|
|
322
|
+
- documentação e snapshots embutidos: [`LICENSE-DATA`](LICENSE-DATA) (`CC BY-SA 4.0`)
|
|
323
|
+
- nota de mapeamento e atribuição: [`LICENSE-NOTE.md`](LICENSE-NOTE.md)
|