Initial organizational README
This commit is contained in:
parent
0944b4b0cc
commit
a9d71807bc
5 changed files with 195 additions and 1 deletions
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
.DS_Store
|
||||
128
profile/CODE_OF_CONDUCT.md
Normal file
128
profile/CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We as members, contributors, and leaders pledge to make participation in our
|
||||
community a harassment-free experience for everyone, regardless of age, body
|
||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
||||
identity and expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
||||
diverse, inclusive, and healthy community.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to a positive environment for our
|
||||
community include:
|
||||
|
||||
* Demonstrating empathy and kindness toward other people
|
||||
* Being respectful of differing opinions, viewpoints, and experiences
|
||||
* Giving and gracefully accepting constructive feedback
|
||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
||||
and learning from the experience
|
||||
* Focusing on what is best not just for us as individuals, but for the
|
||||
overall community
|
||||
|
||||
Examples of unacceptable behavior include:
|
||||
|
||||
* The use of sexualized language or imagery, and sexual attention or
|
||||
advances of any kind
|
||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or email
|
||||
address, without their explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Enforcement Responsibilities
|
||||
|
||||
Community leaders are responsible for clarifying and enforcing our standards of
|
||||
acceptable behavior and will take appropriate and fair corrective action in
|
||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
||||
or harmful.
|
||||
|
||||
Community leaders have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
||||
decisions when appropriate.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all community spaces, and also applies when
|
||||
an individual is officially representing the community in public spaces.
|
||||
Examples of representing our community include using an official e-mail address,
|
||||
posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
mcp-coc@anthropic.com.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
reporter of any incident.
|
||||
|
||||
## Enforcement Guidelines
|
||||
|
||||
Community leaders will follow these Community Impact Guidelines in determining
|
||||
the consequences for any action they deem in violation of this Code of Conduct:
|
||||
|
||||
### 1. Correction
|
||||
|
||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
||||
unprofessional or unwelcome in the community.
|
||||
|
||||
**Consequence**: A private, written warning from community leaders, providing
|
||||
clarity around the nature of the violation and an explanation of why the
|
||||
behavior was inappropriate. A public apology may be requested.
|
||||
|
||||
### 2. Warning
|
||||
|
||||
**Community Impact**: A violation through a single incident or series
|
||||
of actions.
|
||||
|
||||
**Consequence**: A warning with consequences for continued behavior. No
|
||||
interaction with the people involved, including unsolicited interaction with
|
||||
those enforcing the Code of Conduct, for a specified period of time. This
|
||||
includes avoiding interactions in community spaces as well as external channels
|
||||
like social media. Violating these terms may lead to a temporary or
|
||||
permanent ban.
|
||||
|
||||
### 3. Temporary Ban
|
||||
|
||||
**Community Impact**: A serious violation of community standards, including
|
||||
sustained inappropriate behavior.
|
||||
|
||||
**Consequence**: A temporary ban from any sort of interaction or public
|
||||
communication with the community for a specified period of time. No public or
|
||||
private interaction with the people involved, including unsolicited interaction
|
||||
with those enforcing the Code of Conduct, is allowed during this period.
|
||||
Violating these terms may lead to a permanent ban.
|
||||
|
||||
### 4. Permanent Ban
|
||||
|
||||
**Community Impact**: Demonstrating a pattern of violation of community
|
||||
standards, including sustained inappropriate behavior, harassment of an
|
||||
individual, or aggression toward or disparagement of classes of individuals.
|
||||
|
||||
**Consequence**: A permanent ban from any sort of public interaction within
|
||||
the community.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 2.0, available at
|
||||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
||||
|
||||
Community Impact Guidelines were inspired by [Mozilla's code of conduct
|
||||
enforcement ladder](https://github.com/mozilla/diversity).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see the FAQ at
|
||||
https://www.contributor-covenant.org/faq. Translations are available at
|
||||
https://www.contributor-covenant.org/translations.
|
||||
21
profile/CONTRIBUTING.md
Normal file
21
profile/CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# Contributing
|
||||
|
||||
Thank you for your interest in contributing to the MCP!
|
||||
|
||||
Please find the contribution guide for the repositories in the project in the respective repository:
|
||||
|
||||
- [Specification Contributions](https://github.com/modelcontextprotocol/specification/blob/main/CONTRIBUTING.md)
|
||||
- [TypeScript SDK Contributions](https://github.com/modelcontextprotocol/typescript-sdk/blob/main/CONTRIBUTING.md)
|
||||
- [Python SDK Contributions](https://github.com/modelcontextprotocol/python-sdk/blob/main/CONTRIBUTING.md)
|
||||
- [Documentation Contributions](https://github.com/modelcontextprotocol/docs/blob/main/CONTRIBUTING.md)
|
||||
- [Create Python Server Contributions](https://github.com/modelcontextprotocol/create-python-server/blob/main/CONTRIBUTING.md)
|
||||
- [Create TypeScript Server Contributions](https://github.com/modelcontextprotocol/create-typescript-server/blob/main/CONTRIBUTING.md)
|
||||
- [Servers Contributions](https://github.com/modelcontextprotocol/servers/blob/main/CONTRIBUTING.md)
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
|
||||
|
||||
## License
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under the MIT License.
|
||||
|
|
@ -1 +1,45 @@
|
|||
# The Model Context Protocol Project
|
||||
# Model Context Protocol
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/light.png" alt="MCP Logo" />
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<strong>A protocol for seamless integration between LLM applications and external data sources</strong>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://modelcontextprotocol.io">Documentation</a> |
|
||||
<a href="https://spec.modelcontextprotocol.io">Specification</a> |
|
||||
<a href="https://github.com/orgs/modelcontextprotocol/discussions">Discussions</a>
|
||||
</p>
|
||||
|
||||
The Model Context Protocol (MCP) is an open protocol that enables seamless integration between LLM applications and external data sources and tools. Whether you're building an AI-powered IDE, enhancing a chat interface, or creating custom AI workflows, MCP provides a standardized way to connect LLMs with the context they need.
|
||||
|
||||
## Getting Started
|
||||
|
||||
- 📚 Read the [Documentation](https://modelcontextprotocol.io) for guides and tutorials
|
||||
- 🔍 Review the [Specification](https://spec.modelcontextprotocol.io) for protocol details
|
||||
- 💻 Use our SDKs to start building:
|
||||
- [TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)
|
||||
- [Python SDK](https://github.com/modelcontextprotocol/python-sdk)
|
||||
|
||||
## Project Structure
|
||||
|
||||
- [specification](https://github.com/modelcontextprotocol/specification) - Protocol specification and documentation
|
||||
- [typescript-sdk](https://github.com/modelcontextprotocol/typescript-sdk) - TypeScript implementation
|
||||
- [python-sdk](https://github.com/modelcontextprotocol/python-sdk) - Python implementation
|
||||
- [docs](https://github.com/modelcontextprotocol/docs) - User documentation and guides
|
||||
- [create-python-server](https://github.com/modelcontextprotocol/create-python-server) - Python server template
|
||||
- [create-typescript-server](https://github.com/modelcontextprotocol/create-typescript-server) - TypeScript server template
|
||||
- [servers](https://github.com/modelcontextprotocol/servers) - List of maintained servers
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions of all kinds! Whether you want to fix bugs, improve documentation, or propose new features, please see our [contributing guide](CONTRIBUTING.md) to get started.
|
||||
|
||||
Have questions? Join the discussion in our [community forum](https://github.com/orgs/modelcontextprotocol/discussions).
|
||||
|
||||
## About
|
||||
|
||||
The Model Context Protocol is an open source project run by [Anthropic, PBC.](https://anthropic.com) and open to contributions from the entire community.
|
||||
|
|
|
|||
BIN
profile/assets/light.png
Normal file
BIN
profile/assets/light.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
Loading…
Reference in a new issue