@ansvar/automotive-cybersecurity-mcp 1.0.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/.prettierrc.json +9 -0
- package/CHANGELOG.md +63 -0
- package/CONTRIBUTING.md +144 -0
- package/LICENSE +201 -0
- package/QUICK_START.md +189 -0
- package/README.md +981 -0
- package/SECURITY.md +95 -0
- package/data/.gitkeep +0 -0
- package/data/automotive.db +0 -0
- package/data/seed/regulations.json +308 -0
- package/data/seed/standards.json +653 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +41 -0
- package/dist/index.js.map +1 -0
- package/dist/tools/export.d.ts +17 -0
- package/dist/tools/export.d.ts.map +1 -0
- package/dist/tools/export.js +178 -0
- package/dist/tools/export.js.map +1 -0
- package/dist/tools/get.d.ts +17 -0
- package/dist/tools/get.d.ts.map +1 -0
- package/dist/tools/get.js +135 -0
- package/dist/tools/get.js.map +1 -0
- package/dist/tools/list.d.ts +11 -0
- package/dist/tools/list.d.ts.map +1 -0
- package/dist/tools/list.js +67 -0
- package/dist/tools/list.js.map +1 -0
- package/dist/tools/registry.d.ts +16 -0
- package/dist/tools/registry.d.ts.map +1 -0
- package/dist/tools/registry.js +196 -0
- package/dist/tools/registry.js.map +1 -0
- package/dist/tools/search.d.ts +4 -0
- package/dist/tools/search.d.ts.map +1 -0
- package/dist/tools/search.js +126 -0
- package/dist/tools/search.js.map +1 -0
- package/dist/tools/workproducts.d.ts +14 -0
- package/dist/tools/workproducts.d.ts.map +1 -0
- package/dist/tools/workproducts.js +93 -0
- package/dist/tools/workproducts.js.map +1 -0
- package/dist/types/index.d.ts +236 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +5 -0
- package/dist/types/index.js.map +1 -0
- package/docs/CI_CD.md +256 -0
- package/docs/USAGE_GUIDE.md +249 -0
- package/package.json +62 -0
- package/scripts/build-db.ts +424 -0
package/.prettierrc.json
ADDED
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.1.0] - 2026-01-29
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
- Complete UNECE R155 regulation content (12 articles + 5 annexes)
|
|
14
|
+
- Article 7: Full 22KB CSMS specifications
|
|
15
|
+
- Annex 5: Comprehensive 148KB threat catalog
|
|
16
|
+
- All official annexes (communication forms, approval marks, certificates)
|
|
17
|
+
- Complete UNECE R156 regulation content (12 articles + 4 annexes)
|
|
18
|
+
- Article 7: SUMS requirements
|
|
19
|
+
- All official annexes
|
|
20
|
+
- SQLite database with FTS5 full-text search (620KB)
|
|
21
|
+
- Three MCP tools: `list_sources`, `get_requirement`, `search_requirements`
|
|
22
|
+
- Comprehensive test suite (91 tests, 100% pass rate)
|
|
23
|
+
- TypeScript with strict type checking
|
|
24
|
+
- Complete documentation:
|
|
25
|
+
- README.md with quick start
|
|
26
|
+
- QUICK_START.md for 5-minute setup
|
|
27
|
+
- docs/USAGE_GUIDE.md with role-specific scenarios
|
|
28
|
+
- R155_R156_INTEGRATION_SUMMARY.md with technical details
|
|
29
|
+
- CI/CD pipeline with:
|
|
30
|
+
- Multi-platform testing (Ubuntu, macOS, Windows)
|
|
31
|
+
- Multi-version Node.js support (18, 20, 22)
|
|
32
|
+
- Gitleaks secret scanning
|
|
33
|
+
- CodeQL security analysis
|
|
34
|
+
- Automated npm publishing
|
|
35
|
+
|
|
36
|
+
### Changed
|
|
37
|
+
- Database structure: Hierarchical (43 items) → Flat (33 items) with complete text
|
|
38
|
+
- Content source: Manual summaries → Official UNECE text via EU Compliance MCP
|
|
39
|
+
- Database size: 152KB → 620KB (4x increase)
|
|
40
|
+
- Content size: ~50KB → 294KB (6x increase)
|
|
41
|
+
|
|
42
|
+
### Attribution
|
|
43
|
+
- R155/R156 content sourced from [EU Compliance MCP](https://github.com/Ansvar-Systems/EU_compliance_MCP)
|
|
44
|
+
- License: Apache 2.0 (compatible)
|
|
45
|
+
- Data: Official UNECE regulations from EUR-Lex
|
|
46
|
+
|
|
47
|
+
### Technical
|
|
48
|
+
- Node.js: 18+ required
|
|
49
|
+
- Database: SQLite 3 with FTS5
|
|
50
|
+
- Query performance: <1ms average
|
|
51
|
+
- Package size: ~650KB (includes 620KB database)
|
|
52
|
+
|
|
53
|
+
## [0.0.1] - 2026-01-28 (Initial Development)
|
|
54
|
+
|
|
55
|
+
### Added
|
|
56
|
+
- Initial MCP server structure
|
|
57
|
+
- Sample R155 content (hierarchical structure)
|
|
58
|
+
- ISO 21434 Clause 9.3 guidance
|
|
59
|
+
- Basic testing framework
|
|
60
|
+
|
|
61
|
+
[Unreleased]: https://github.com/Ansvar-Systems/Automotive-MCP/compare/v0.1.0...HEAD
|
|
62
|
+
[0.1.0]: https://github.com/Ansvar-Systems/Automotive-MCP/releases/tag/v0.1.0
|
|
63
|
+
[0.0.1]: https://github.com/Ansvar-Systems/Automotive-MCP/releases/tag/v0.0.1
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# Contributing to Automotive Cybersecurity MCP
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing to the Automotive Cybersecurity MCP Server! This document provides guidelines and instructions for contributing.
|
|
4
|
+
|
|
5
|
+
## Code of Conduct
|
|
6
|
+
|
|
7
|
+
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
8
|
+
|
|
9
|
+
## How to Contribute
|
|
10
|
+
|
|
11
|
+
### Reporting Bugs
|
|
12
|
+
|
|
13
|
+
Before creating bug reports, please check existing issues to avoid duplicates. When creating a bug report, include:
|
|
14
|
+
|
|
15
|
+
- **Clear title** describing the issue
|
|
16
|
+
- **Steps to reproduce** the behavior
|
|
17
|
+
- **Expected behavior** vs actual behavior
|
|
18
|
+
- **Environment details** (Node.js version, OS, Claude Desktop version)
|
|
19
|
+
- **Error messages** or logs if applicable
|
|
20
|
+
|
|
21
|
+
### Suggesting Enhancements
|
|
22
|
+
|
|
23
|
+
Enhancement suggestions are welcome! Please include:
|
|
24
|
+
|
|
25
|
+
- **Clear title** describing the enhancement
|
|
26
|
+
- **Detailed description** of the proposed functionality
|
|
27
|
+
- **Use case** explaining why this would be valuable
|
|
28
|
+
- **Possible implementation** if you have ideas
|
|
29
|
+
|
|
30
|
+
### Pull Requests
|
|
31
|
+
|
|
32
|
+
1. **Fork the repository** and create your branch from `main`
|
|
33
|
+
2. **Follow the coding style** of the project
|
|
34
|
+
3. **Add tests** for any new functionality
|
|
35
|
+
4. **Update documentation** if needed
|
|
36
|
+
5. **Ensure CI passes** before requesting review
|
|
37
|
+
|
|
38
|
+
## Development Setup
|
|
39
|
+
|
|
40
|
+
### Prerequisites
|
|
41
|
+
|
|
42
|
+
- Node.js 18 or higher
|
|
43
|
+
- npm 9 or higher
|
|
44
|
+
|
|
45
|
+
### Local Development
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Clone your fork
|
|
49
|
+
git clone https://github.com/YOUR-USERNAME/Automotive-MCP.git
|
|
50
|
+
cd Automotive-MCP
|
|
51
|
+
|
|
52
|
+
# Install dependencies
|
|
53
|
+
npm install
|
|
54
|
+
|
|
55
|
+
# Build the database
|
|
56
|
+
npm run build:db
|
|
57
|
+
|
|
58
|
+
# Build TypeScript
|
|
59
|
+
npm run build
|
|
60
|
+
|
|
61
|
+
# Run tests
|
|
62
|
+
npm test
|
|
63
|
+
|
|
64
|
+
# Run in development mode
|
|
65
|
+
npm run dev
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Project Structure
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
├── src/ # TypeScript source code
|
|
72
|
+
│ ├── index.ts # MCP server entry point
|
|
73
|
+
│ ├── tools/ # Tool implementations
|
|
74
|
+
│ ├── db/ # Database operations
|
|
75
|
+
│ └── types/ # TypeScript type definitions
|
|
76
|
+
├── scripts/ # Build and utility scripts
|
|
77
|
+
├── data/ # Seed data and generated database
|
|
78
|
+
├── tests/ # Test files
|
|
79
|
+
└── .github/ # GitHub Actions and templates
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Coding Guidelines
|
|
83
|
+
|
|
84
|
+
### TypeScript
|
|
85
|
+
|
|
86
|
+
- Use TypeScript strict mode
|
|
87
|
+
- Prefer `const` over `let`
|
|
88
|
+
- Use meaningful variable names
|
|
89
|
+
- Add JSDoc comments for public APIs
|
|
90
|
+
|
|
91
|
+
### Commits
|
|
92
|
+
|
|
93
|
+
Follow [Conventional Commits](https://www.conventionalcommits.org/):
|
|
94
|
+
|
|
95
|
+
- `feat:` new feature
|
|
96
|
+
- `fix:` bug fix
|
|
97
|
+
- `docs:` documentation only
|
|
98
|
+
- `test:` adding or updating tests
|
|
99
|
+
- `refactor:` code change that neither fixes a bug nor adds a feature
|
|
100
|
+
- `chore:` maintenance tasks
|
|
101
|
+
- `ci:` CI/CD changes
|
|
102
|
+
|
|
103
|
+
Examples:
|
|
104
|
+
```
|
|
105
|
+
feat: add support for ISO 21434 clause queries
|
|
106
|
+
fix: handle empty search results gracefully
|
|
107
|
+
docs: update installation instructions
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Testing
|
|
111
|
+
|
|
112
|
+
- Write tests for new features
|
|
113
|
+
- Maintain or improve test coverage
|
|
114
|
+
- Run `npm test` before submitting PRs
|
|
115
|
+
|
|
116
|
+
## Database Changes
|
|
117
|
+
|
|
118
|
+
The automotive regulations database is built from seed files in `data/seed/`. If you need to modify the database schema or content:
|
|
119
|
+
|
|
120
|
+
1. Update the relevant seed files
|
|
121
|
+
2. Update the schema in `scripts/build-db.ts` if needed
|
|
122
|
+
3. Rebuild with `npm run build:db`
|
|
123
|
+
4. Add tests for new data
|
|
124
|
+
|
|
125
|
+
## Review Process
|
|
126
|
+
|
|
127
|
+
1. **Automated checks** must pass (CI, linting, tests)
|
|
128
|
+
2. **Code review** by a maintainer
|
|
129
|
+
3. **Approval** required before merging
|
|
130
|
+
4. **Squash merge** is preferred for clean history
|
|
131
|
+
|
|
132
|
+
## Getting Help
|
|
133
|
+
|
|
134
|
+
- Open an issue for questions
|
|
135
|
+
- Check existing documentation
|
|
136
|
+
- Review closed issues for similar problems
|
|
137
|
+
|
|
138
|
+
## Recognition
|
|
139
|
+
|
|
140
|
+
Contributors are recognized in release notes. Thank you for helping improve automotive cybersecurity tooling!
|
|
141
|
+
|
|
142
|
+
## License
|
|
143
|
+
|
|
144
|
+
By contributing, you agree that your contributions will be licensed under the [Apache 2.0 License](LICENSE).
|
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 Support. 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 2026 Jeffrey von Rotz / Ansvar Systems
|
|
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/QUICK_START.md
ADDED
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
# Quick Start: Automotive Cybersecurity MCP
|
|
2
|
+
|
|
3
|
+
## What Is This?
|
|
4
|
+
|
|
5
|
+
**Ask Claude questions about automotive cybersecurity regulations (UNECE R155/R156) and get instant answers with exact source references.**
|
|
6
|
+
|
|
7
|
+
Stop searching through 200+ page PDFs. Just ask.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 30-Second Setup
|
|
12
|
+
|
|
13
|
+
1. Add to `~/.claude/claude_desktop_config.json`:
|
|
14
|
+
```json
|
|
15
|
+
{
|
|
16
|
+
"mcpServers": {
|
|
17
|
+
"automotive": {
|
|
18
|
+
"command": "npx",
|
|
19
|
+
"args": ["-y", "@ansvar/automotive-cybersecurity-mcp"]
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
2. Restart Claude Desktop
|
|
26
|
+
|
|
27
|
+
3. Done! Start asking questions.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## When to Use This
|
|
32
|
+
|
|
33
|
+
### ✅ USE THIS WHEN:
|
|
34
|
+
|
|
35
|
+
**1. Preparing for Type Approval**
|
|
36
|
+
- "What CSMS documentation does R155 require?"
|
|
37
|
+
- "Show me R155 Annex 4 certificate template"
|
|
38
|
+
|
|
39
|
+
**2. Answering Customer Questions**
|
|
40
|
+
- "What does R155 Article 7.2.2.2 say about vulnerability management?"
|
|
41
|
+
- "Explain R156 software update requirements"
|
|
42
|
+
|
|
43
|
+
**3. Creating Compliance Docs**
|
|
44
|
+
- "List all R155 incident response requirements"
|
|
45
|
+
- "Generate R155 Article 7 compliance checklist"
|
|
46
|
+
|
|
47
|
+
**4. Gap Analysis**
|
|
48
|
+
- "What are the R155 requirements for supply chain security?"
|
|
49
|
+
- "Compare our process to R156 Article 7"
|
|
50
|
+
|
|
51
|
+
**5. Training & Education**
|
|
52
|
+
- "Explain R155 in simple terms"
|
|
53
|
+
- "Create quiz questions from R155 Article 7"
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Common Questions
|
|
58
|
+
|
|
59
|
+
### OEM Preparing for Approval
|
|
60
|
+
```
|
|
61
|
+
Q: "I'm preparing our R155 type approval package. What do I need?"
|
|
62
|
+
A: [Claude returns Article 3, Annex 4, Annex 5 requirements]
|
|
63
|
+
|
|
64
|
+
Q: "Show me the CSMS certificate template"
|
|
65
|
+
A: [Claude returns Annex 4 complete template]
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Supplier Responding to RFQ
|
|
69
|
+
```
|
|
70
|
+
Q: "Customer asked about R155 Article 7.2.2.2.f - what is that?"
|
|
71
|
+
A: [Claude returns supply chain security requirements]
|
|
72
|
+
|
|
73
|
+
Q: "What evidence do I need to provide?"
|
|
74
|
+
A: [Claude explains expected documentation]
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Security Engineer Implementing Controls
|
|
78
|
+
```
|
|
79
|
+
Q: "What does R155 require for penetration testing?"
|
|
80
|
+
A: [Claude searches and returns Article 7.2.3 testing requirements]
|
|
81
|
+
|
|
82
|
+
Q: "Search R155 for 'intrusion detection'"
|
|
83
|
+
A: [Claude finds all mentions with context]
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## What You Get
|
|
89
|
+
|
|
90
|
+
**Content:**
|
|
91
|
+
- ✅ Complete R155 regulation (17 items, 12 articles + 5 annexes)
|
|
92
|
+
- ✅ Complete R156 regulation (16 items, 12 articles + 4 annexes)
|
|
93
|
+
- ✅ Full-text search across 294KB of regulation text
|
|
94
|
+
- ✅ Exact article references for citations
|
|
95
|
+
|
|
96
|
+
**Not Included:**
|
|
97
|
+
- ❌ ISO 21434 full text (copyrighted - we have 1 clause guidance only)
|
|
98
|
+
- ❌ Legal advice (regulations ≠ legal interpretation)
|
|
99
|
+
- ❌ Certification decisions (contact type approval authority)
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## ROI
|
|
104
|
+
|
|
105
|
+
**Without MCP:**
|
|
106
|
+
- Compliance consultant: $300/hour
|
|
107
|
+
- 10 questions/month = $3,000/month
|
|
108
|
+
- Annual cost: **$36,000**
|
|
109
|
+
|
|
110
|
+
**With MCP:**
|
|
111
|
+
- Cost: **$0** (open source)
|
|
112
|
+
- Time per question: 2 minutes vs 1 hour
|
|
113
|
+
- Annual savings: **$36,000**
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Example Workflow
|
|
118
|
+
|
|
119
|
+
**Scenario:** You received RFQ asking about R155 compliance
|
|
120
|
+
|
|
121
|
+
**Traditional Approach (2-3 days):**
|
|
122
|
+
1. Download 200-page R155 PDF
|
|
123
|
+
2. Search for relevant sections
|
|
124
|
+
3. Read entire articles for context
|
|
125
|
+
4. Cross-reference annexes
|
|
126
|
+
5. Write response
|
|
127
|
+
6. Have consultant review
|
|
128
|
+
|
|
129
|
+
**With MCP (30 minutes):**
|
|
130
|
+
```
|
|
131
|
+
You: "What does R155 require for CSMS documentation?"
|
|
132
|
+
→ Instant article list with references
|
|
133
|
+
|
|
134
|
+
You: "Show me Article 7.2.2.2 supply chain requirements"
|
|
135
|
+
→ Complete requirement text
|
|
136
|
+
|
|
137
|
+
You: "What evidence would an auditor expect?"
|
|
138
|
+
→ Guidance on documentation
|
|
139
|
+
|
|
140
|
+
You: "Draft response email about our compliance"
|
|
141
|
+
→ Claude generates response with citations
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## Sample Questions to Try
|
|
147
|
+
|
|
148
|
+
**Understanding Requirements:**
|
|
149
|
+
- "Explain R155 Article 7 in simple terms"
|
|
150
|
+
- "What's the difference between R155 and R156?"
|
|
151
|
+
- "Show me all R155 annexes"
|
|
152
|
+
|
|
153
|
+
**Finding Specific Info:**
|
|
154
|
+
- "Search R155 for 'vulnerability management'"
|
|
155
|
+
- "What does R155 say about incident response?"
|
|
156
|
+
- "Find all R156 requirements about software updates"
|
|
157
|
+
|
|
158
|
+
**Creating Documentation:**
|
|
159
|
+
- "Generate compliance checklist from R155 Article 7"
|
|
160
|
+
- "Create gap analysis template for R155"
|
|
161
|
+
- "List all R155 required work products"
|
|
162
|
+
|
|
163
|
+
**Answering Auditor Questions:**
|
|
164
|
+
- "What evidence does R155 require for CSMS approval?"
|
|
165
|
+
- "Explain R155 Annex 5 threat categories"
|
|
166
|
+
- "What is conformity of production in R155?"
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## Technical Details
|
|
171
|
+
|
|
172
|
+
**Database:** 620KB SQLite with FTS5 full-text search
|
|
173
|
+
**Performance:** <1ms query response
|
|
174
|
+
**Content:** 33 regulation items (294KB text)
|
|
175
|
+
**Tests:** 91/91 passing
|
|
176
|
+
**License:** Apache 2.0 (free commercial use)
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## Need More?
|
|
181
|
+
|
|
182
|
+
📖 **Full Usage Guide:** `docs/USAGE_GUIDE.md`
|
|
183
|
+
📋 **Integration Summary:** `R155_R156_INTEGRATION_SUMMARY.md`
|
|
184
|
+
🐛 **Issues:** https://github.com/Ansvar-Systems/Automotive-MCP/issues
|
|
185
|
+
📚 **EU Regulations:** https://github.com/Ansvar-Systems/EU_compliance_MCP
|
|
186
|
+
|
|
187
|
+
---
|
|
188
|
+
|
|
189
|
+
**Ready? Just ask Claude your first R155/R156 question! 🚀**
|