Skip to content

Commit da6d69d

Browse files
jspahrsummersjspahrsummers
committed
Add 'imported-docs/' from commit '0e743332b27863abf63475eb22b642bd95b59f0f'
git-subtree-dir: imported-docs git-subtree-mainline: 41749db git-subtree-split: 0e74333
2 parents 41749db + 0e74333 commit da6d69d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+9616
-0
lines changed

‎imported-docs/.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.mdx

‎imported-docs/CLAUDE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# MCP Documentation Guidelines
2+
3+
## Build Commands
4+
- Preview changes locally: `mintlify dev`
5+
- Deploy: Automatic after PR merge to main branch
6+
7+
## Style Guidelines
8+
- Follow existing MDX formatting and components
9+
- Keep content clear, concise, and technically accurate
10+
- Include practical code examples where appropriate
11+
- Test all links and code samples before submitting
12+
- Maintain consistent structure with existing documentation
13+
- When documenting CLI commands, use two-line format with the prompt on a separate line: `$ claude` followed by `> /command`
14+
- Use appropriate headings: "When to use", "Steps", and "Tips" for tutorials
15+
- Branch naming convention: prefix with "ashwin/" (e.g., "ashwin/add-mcp-cli-docs")
16+
17+
## File Organization
18+
- Place new pages in appropriate sections (concepts, tutorials, etc.)
19+
- Update docs.json when adding new pages
20+
- Follow existing file naming conventions (kebab-case.mdx)
21+
- Include proper frontmatter in MDX files
22+
23+
## Documentation Standards
24+
- Prioritize user understanding over technical completeness
25+
- Document both basic syntax and concrete examples
26+
- Structure command documentation with clear formatting
27+
- For image analysis examples, use quotes: `$ claude "Analyze this image: /path/to/image.png"`

‎imported-docs/CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎imported-docs/CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to MCP Documentation
2+
3+
Thank you for your interest in contributing to the Model Context Protocol (MCP) documentation! This guide will help you get started with contributing.
4+
5+
## Getting Started
6+
7+
1. Install the required tools:
8+
- Node.js
9+
- Git
10+
- [Mintlify CLI](https://www.npmjs.com/package/mintlify): `npm i -g mintlify`
11+
2. Fork and clone the repository
12+
3. Create a new branch for your changes
13+
4. Run `mintlify dev` to preview changes locally
14+
15+
## Documentation Guidelines
16+
17+
- Keep content clear, concise, and technically accurate
18+
- Follow the existing file structure and naming conventions
19+
- Include code examples where appropriate
20+
- Use proper MDX formatting and components
21+
- Test all links and code samples
22+
23+
## Content Types
24+
25+
You can contribute to:
26+
27+
- Conceptual guides
28+
- API reference documentation
29+
- Tutorials and quickstarts
30+
- Best practices and examples
31+
- Troubleshooting guides
32+
33+
## Pull Request Process
34+
35+
1. Ensure your changes follow our documentation guidelines
36+
2. Update the relevant table of contents if needed
37+
3. Test your changes locally using `mintlify dev`
38+
4. Submit a pull request with a clear description of your changes
39+
5. Wait for review and address any feedback
40+
41+
## Need Help?
42+
43+
- Check existing documentation at [modelcontextprotocol.io](https://modelcontextprotocol.io)
44+
- [Open an issue](https://github.com/modelcontextprotocol/docs/issues) for bugs or concerns
45+
- Join our [community discussions](https://github.com/modelcontextprotocol/docs/discussions)
46+
47+
## Code of Conduct
48+
49+
Please note that this project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold these guidelines.

‎imported-docs/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024–2025 Anthropic, PBC and contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎imported-docs/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Model Context Protocol Documentation
2+
3+
The official documentation for the [Model Context Protocol](https://modelcontextprotocol.io).
4+
5+
For detailed contribution guidelines, development setup, and troubleshooting, please see our [Contributing Guide](CONTRIBUTING.md).
6+
7+
### Publishing Changes
8+
9+
Changes will be deployed to production automatically after pushing to the default branch.

0 commit comments

Comments
 (0)