{"id":30870000,"url":"https://github.com/aidecentralized/MCP_Hackathon_docs","last_synced_at":"2025-09-07T22:20:27.094Z","repository":{"id":286411868,"uuid":"961103128","full_name":"aidecentralized/MCP_Hackathon_docs","owner":"aidecentralized","description":"Read the docs Documentation for the MIT decentralized AI, MCP hackathon","archived":false,"fork":false,"pushed_at":"2025-04-08T13:16:08.000Z","size":5831,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T22:24:34.427Z","etag":null,"topics":["ai","decentralized","hackathon","mcp","mcp-server","mit"],"latest_commit_sha":null,"homepage":"https://aidecentralized.github.io/MCP_Hackathon_docs/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aidecentralized.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-05T18:57:46.000Z","updated_at":"2025-04-08T13:15:53.000Z","dependencies_parsed_at":"2025-04-09T22:22:11.376Z","dependency_job_id":null,"html_url":"https://github.com/aidecentralized/MCP_Hackathon_docs","commit_stats":null,"previous_names":["aidecentralized/mcp_hackathon_docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aidecentralized/MCP_Hackathon_docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidecentralized%2FMCP_Hackathon_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidecentralized%2FMCP_Hackathon_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidecentralized%2FMCP_Hackathon_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidecentralized%2FMCP_Hackathon_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aidecentralized","download_url":"https://codeload.github.com/aidecentralized/MCP_Hackathon_docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aidecentralized%2FMCP_Hackathon_docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274103633,"owners_count":25222832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","decentralized","hackathon","mcp","mcp-server","mit"],"created_at":"2025-09-07T22:04:26.910Z","updated_at":"2025-09-07T22:20:27.054Z","avatar_url":"https://github.com/aidecentralized.png","language":"HTML","funding_links":[],"categories":["🤖 AI/ML"],"sub_categories":[],"readme":"# MCP Python SDK Documentation\n\nThis repository contains the documentation for the Model Context Protocol (MCP) Python SDK. It is built using Sphinx and the Read the Docs theme.\n\n## Overview\n\nThe Model Context Protocol (MCP) is an open standard that defines how applications interact with large language models (LLMs). This documentation aims to help developers:\n\n- Understand the core concepts of MCP\n- Build MCP servers to expose resources, tools, and prompts\n- Create MCP clients to connect to MCP servers\n- Explore advanced topics and best practices\n\n## FastMCP\n\nOur documentation includes comprehensive coverage of FastMCP, a high-level, Pythonic interface for building MCP servers. Originally a standalone project, FastMCP has been integrated into the official MCP Python SDK. It provides a developer-friendly way to create MCP servers with minimal boilerplate:\n\n```python\nfrom mcp.server.fastmcp import FastMCP\n\nmcp = FastMCP(\"Demo 🚀\")\n\n@mcp.tool()\ndef add(a: int, b: int) -\u003e int:\n    \"\"\"Add two numbers\"\"\"\n    return a + b\n```\n\nThe SDK provides multiple ways to run your server:\n- Development mode with the MCP Inspector\n- Claude Desktop integration\n- Direct execution for custom deployments\n\n## Building the Documentation\n\n1. **Install Dependencies**\n\n   First, make sure you have Python installed. Then, install the required packages:\n\n   ```bash\n   # Using conda (recommended)\n   conda activate cuda_test\n   pip install -r requirements.txt\n   \n   # Or using pip in a virtual environment\n   python -m venv venv\n   source venv/bin/activate  # On Windows: venv\\Scripts\\activate\n   pip install -r requirements.txt\n   ```\n\n2. **Build the Documentation**\n\n   To build the documentation:\n\n   ```bash\n   make html\n   ```\n\n   The built documentation will be in the `_build/html/` directory.\n\n3. **Live Preview**\n\n   For a live preview with auto-reload:\n\n   ```bash\n   sphinx-autobuild . _build/html\n   ```\n\n   Then open your browser to http://localhost:8000.\n\n## Hosting on GitHub Pages\n\nYou can host this documentation on GitHub Pages by following these steps:\n\n1. **Create a GitHub Repository**\n\n   ```bash\n   # Initialize a local repository if you haven't already\n   git init\n   git add .\n   git commit -m \"Initial commit with MCP documentation\"\n   \n   # Create a repository on GitHub through the web interface\n   # Then add the remote and push\n   git remote add origin https://github.com/yourusername/mcp_docs.git\n   git push -u origin main\n   ```\n\n2. **Set Up GitHub Pages**\n\n   There are two ways to set up GitHub Pages for your documentation:\n\n   ### Option 1: Using GitHub Actions (Recommended)\n\n   The repository already includes a GitHub Actions workflow at `.github/workflows/docs.yml` that will automatically build and deploy the documentation to GitHub Pages whenever you push to the main branch.\n\n   1. Go to your GitHub repository\n   2. Navigate to \"Settings\" \u003e \"Pages\"\n   3. Under \"Source\", select \"GitHub Actions\"\n   4. Make sure the \"GitHub Actions\" workflow is running after your first push\n\n   ### Option 2: Manual Setup with gh-pages Branch\n\n   If you prefer to manage the deployment manually:\n\n   ```bash\n   # Create an orphan gh-pages branch\n   git checkout --orphan gh-pages\n   git rm -rf .\n   touch .nojekyll\n   git add .nojekyll\n   git commit -m \"Initial gh-pages commit\"\n   git push origin gh-pages\n   git checkout main\n   \n   # Build and copy the documentation to gh-pages\n   make html\n   git checkout gh-pages\n   cp -r _build/html/* .\n   git add .\n   git commit -m \"Update documentation\"\n   git push origin gh-pages\n   git checkout main\n   ```\n\n   Then go to your GitHub repository's Settings \u003e Pages and select the gh-pages branch as the source.\n\n3. **Access Your Documentation**\n\n   Your documentation will be available at:\n   `https://yourusername.github.io/mcp_docs/`\n\n4. **Update the Documentation**\n\n   Whenever you want to update the documentation:\n\n   ```bash\n   # If using GitHub Actions\n   # Just push your changes to the main branch\n   git add .\n   git commit -m \"Update documentation\"\n   git push origin main\n   \n   # If using manual gh-pages setup\n   make html\n   git checkout gh-pages\n   cp -r _build/html/* .\n   git add .\n   git commit -m \"Update documentation\"\n   git push origin gh-pages\n   git checkout main\n   ```\n\n## Documentation Structure\n\n- `index.rst`: Main entry point\n- `introduction.rst`: Introduction to MCP\n- `getting-started.rst`: Getting started guide\n- `server-guide.rst`: Guide for building MCP servers\n- `client-guide.rst`: Guide for building MCP clients\n- `examples.rst`: Example MCP applications\n- `advanced-topics.rst`: Advanced MCP concepts\n- `api-reference.rst`: API reference\n\n## Contributing\n\nContributions to improve the documentation are welcome! Here's how you can contribute:\n\n1. Fork the repository\n2. Create a new branch for your changes\n3. Make your changes\n4. Build the documentation to verify your changes\n5. Submit a pull request\n\n## Resources\n\n- [Official MCP Website](https://modelcontextprotocol.io/)\n- [MCP Python SDK GitHub](https://github.com/modelcontextprotocol/python-sdk)\n- [MCP Specification](https://spec.modelcontextprotocol.io/)\n- [Officially Supported Servers](https://github.com/modelcontextprotocol/servers)\n- [GitHub Discussions](https://github.com/modelcontextprotocol/python-sdk/discussions)\n- [FastMCP GitHub (Legacy)](https://github.com/jlowin/fastmcp)\n\n## License\n\nThis documentation is licensed under the MIT License - see the LICENSE file for details. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faidecentralized%2FMCP_Hackathon_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faidecentralized%2FMCP_Hackathon_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faidecentralized%2FMCP_Hackathon_docs/lists"}