Skip to content

Commit a1048b9

Browse files
authored
Add embedded MkDocs documentation site (#795)
Copy and convert existing MCP documentation into an embedded docs site using MkDocs with Material theme. Includes client and server guides, quickstart, development/contributing docs, architecture diagrams, and a GitHub Actions workflow for publishing to GitHub Pages. --------- Signed-off-by: Christian Tzolov <christian.tzolov@broadcom.com>
1 parent e60a074 commit a1048b9

18 files changed

+2130
-328
lines changed

.github/workflows/docs.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: write
14+
15+
jobs:
16+
deploy:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
21+
- uses: actions/setup-python@v5
22+
with:
23+
python-version: 3.x
24+
25+
- run: pip install mkdocs-material
26+
27+
- run: mkdocs gh-deploy --force

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ node_modules/
5757
package-lock.json
5858
package.json
5959

60+
### MkDocs ###
61+
site/
62+
6063
### Other ###
6164
.antlr/
6265
.profiler/

docs/CONTRIBUTING.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: Contributing
3+
description: How to contribute to the MCP Java SDK
4+
---
5+
6+
# Contributing
7+
8+
Thank you for your interest in contributing to the Model Context Protocol Java SDK!
9+
This guide outlines how to contribute to this project.
10+
11+
## Prerequisites
12+
13+
!!! info "Required Software"
14+
- **Java 17** or above
15+
- **Docker**
16+
- **npx**
17+
18+
## Getting Started
19+
20+
1. Fork the repository
21+
2. Clone your fork:
22+
23+
```bash
24+
git clone https://github.com/YOUR-USERNAME/java-sdk.git
25+
cd java-sdk
26+
```
27+
28+
3. Build from source:
29+
30+
```bash
31+
./mvnw clean install -DskipTests # skip the tests
32+
./mvnw test # run tests
33+
```
34+
35+
## Reporting Issues
36+
37+
Please create an issue in the repository if you discover a bug or would like to
38+
propose an enhancement. Bug reports should have a reproducer in the form of a code
39+
sample or a repository attached that the maintainers or contributors can work with to
40+
address the problem.
41+
42+
## Making Changes
43+
44+
1. Create a new branch:
45+
46+
```bash
47+
git checkout -b feature/your-feature-name
48+
```
49+
50+
2. Make your changes.
51+
52+
3. Validate your changes:
53+
54+
```bash
55+
./mvnw clean test
56+
```
57+
58+
### Change Proposal Guidelines
59+
60+
#### Principles of MCP
61+
62+
1. **Simple + Minimal**: It is much easier to add things to the codebase than it is to
63+
remove them. To maintain simplicity, we keep a high bar for adding new concepts and
64+
primitives as each addition requires maintenance and compatibility consideration.
65+
2. **Concrete**: Code changes need to be based on specific usage and implementation
66+
challenges and not on speculative ideas. Most importantly, the SDK is meant to
67+
implement the MCP specification.
68+
69+
## Submitting Changes
70+
71+
1. For non-trivial changes, please clarify with the maintainers in an issue whether
72+
you can contribute the change and the desired scope of the change.
73+
2. For trivial changes (for example a couple of lines or documentation changes) there
74+
is no need to open an issue first.
75+
3. Push your changes to your fork.
76+
4. Submit a pull request to the main repository.
77+
5. Follow the pull request template.
78+
6. Wait for review.
79+
7. For any follow-up work, please add new commits instead of force-pushing. This will
80+
allow the reviewer to focus on incremental changes instead of having to restart the
81+
review process.
82+
83+
## Code of Conduct
84+
85+
This project follows a Code of Conduct. Please review it in
86+
[CODE_OF_CONDUCT.md](https://github.com/modelcontextprotocol/java-sdk/blob/main/CODE_OF_CONDUCT.md).
87+
88+
## Questions
89+
90+
If you have questions, please create a discussion in the repository.
91+
92+
## License
93+
94+
By contributing, you agree that your contributions will be licensed under the MIT
95+
License.
96+
97+
## Security
98+
99+
This SDK is maintained by [Anthropic](https://www.anthropic.com/) as part of the Model Context Protocol project.
100+
101+
The security of our systems and user data is Anthropic's top priority. We appreciate the work of security researchers acting in good faith in identifying and reporting potential vulnerabilities.
102+
103+
!!! warning "Reporting Security Vulnerabilities"
104+
Do **not** report security vulnerabilities through public GitHub issues. Instead, report them through our HackerOne [submission form](https://hackerone.com/anthropic-vdp/reports/new?type=team&report_type=vulnerability).
105+
106+
Our Vulnerability Disclosure Program guidelines are defined on our [HackerOne program page](https://hackerone.com/anthropic-vdp).

0 commit comments

Comments
 (0)