finished draft of quickstarts

This commit is contained in:
Zack Lee 2024-11-18 08:48:20 -05:00
commit e4dd2199fe
No known key found for this signature in database

View file

@ -1,63 +1,142 @@
---
title: Introduction
description: 'Introduction to the Model Context Protocol'
description: 'Get started with the Model Context Protocol (MCP)'
---
The Model Context Protocol (MCP) is a protocol designed to enable LLM assistant surfaces to receive contextual information from specialized servers. Whether you’re building an IDE coding assistant, a chat interface, or any other LLM-powered application, MCP provides a standardized way to obtain and utilize relevant context.
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.
## Quickstart Guides
## Get started
The first step to world-class documentation is setting up your editing environments.
Choose the path that best fits your needs:
<CardGroup cols={2}>
<Card
title="Edit Your Docs"
icon="pen-to-square"
href="https://mintlify.com/docs/quickstart"
title="Try MCP with Claude"
icon="bolt"
href="/docs/guides/claude"
>
Get your docs set up locally for easy development
The fastest way to see MCP in action - connect example servers to Claude in minutes
</Card>
<Card
title="Preview Changes"
icon="image"
href="https://mintlify.com/docs/development"
>
Preview your changes before you push to make sure they're perfect
</Card>
</CardGroup>
## Make it yours
Update your docs to your brand and add valuable content for the best user conversion.
<CardGroup cols={2}>
<Card
title="Customize Style"
icon="palette"
href="https://mintlify.com/docs/settings/global"
>
Customize your docs to your company's colors and brands
</Card>
<Card
title="Reference APIs"
title="Build Your First Server (TypeScript)"
icon="code"
href="https://mintlify.com/docs/api-playground/openapi"
href="/docs/guides/first-server-ts"
>
Automatically generate endpoints from an OpenAPI spec
Create a simple MCP server in TypeScript to understand the basics
</Card>
<Card
title="Add Components"
icon="screwdriver-wrench"
href="https://mintlify.com/docs/components/accordion"
title="Build Your First Server (Python)"
icon="python"
href="/docs/guides/first-server-python"
>
Build interactive features and designs to guide your users
Create a simple MCP server in Python to understand the basics
</Card>
<Card
title="Get Inspiration"
icon="stars"
href="https://mintlify.com/customers"
title="Integrate MCP (TypeScript)"
icon="plug"
href="/docs/guides/integrate-ts"
>
Check out our showcase of our favorite documentation
Add MCP support to your TypeScript/JavaScript LLM application
</Card>
<Card
title="Integrate MCP (Python)"
icon="plug"
href="/docs/guides/integrate-python"
>
Add MCP support to your Python LLM application
</Card>
</CardGroup>
## Explore MCP
Dive deeper into MCP's core concepts and capabilities:
<CardGroup cols={3}>
<Card
title="Core Architecture"
icon="sitemap"
href="/core/architecture"
>
Understand how MCP connects clients, servers, and LLMs
</Card>
<Card
title="Resources"
icon="database"
href="/core/resources"
>
Expose data and content from your servers to LLMs
</Card>
<Card
title="Prompts"
icon="message"
href="/core/prompts"
>
Create reusable prompt templates and workflows
</Card>
<Card
title="Tools"
icon="wrench"
href="/core/tools"
>
Enable LLMs to perform actions through your server
</Card>
<Card
title="Sampling"
icon="robot"
href="/core/sampling"
>
Let your servers request completions from LLMs
</Card>
<Card
title="Transport"
icon="network-wired"
href="/core/transport"
>
Learn about MCP's communication mechanisms
</Card>
</CardGroup>
## Example Use Cases
See what you can build with MCP:
<CardGroup cols={2}>
<Card
title="Custom Knowledge Base"
icon="book"
>
Connect your documentation, wikis, and internal knowledge bases to LLMs
</Card>
<Card
title="Database Integration"
icon="database"
>
Query databases and analyze results with natural language
</Card>
<Card
title="Local Development"
icon="code"
>
Build AI-powered development tools with access to local files and git
</Card>
<Card
title="Enterprise Systems"
icon="building"
>
Securely connect enterprise tools and data to AI interfaces
</Card>
</CardGroup>
## Security and Best Practices
MCP is designed with security in mind, but requires careful implementation:
<Card
title="Security Guide"
icon="shield"
href="/security"
>
Learn about MCP's security model, best practices, and implementation guidelines
</Card>
Want to contribute? Check out our [GitHub repository](https://github.com/modelcontextprotocol) or join our growing community of developers building with MCP.