Snippy

🚀 Snippy

Snippy is a code snippet management tool built on Microsoft Azure. It allows users to manage and manipulate code snippets through the following features:

• Save selected code snippets to cloud storage.
• Search for and display saved code snippets by name.
• Automatically generate project wikis and code style guides from stored code snippets.

🚀 Quick Start

Local Deployment

1. Environment Setup:
   • Install Docker for local development.
   • Install Azurite and Cosmos Emulator to simulate cloud services.
2. Clone the Repository:

   git clone https://github.com/Azure-Samples/snippy.git
   cd snippy
   

3. Configure Local Environment Variables:
   • Create a local.settings.json file and fill in the following content (modify the placeholders according to your actual situation):

   {
     "COSMOS_CONN": "<Your Cosmos connection string>",
     "AZURE_OPENAI_ENDPOINT": "<Your OpenAI endpoint>",
     "AZURE_OPENAI_KEY": "<Your OpenAI key>",
     "PROJECT_CONNECTION_STRING": "<Your project connection string>"
   }
   

4. Start the Local Service:

   func start
   

   The service will run at http://localhost:7071.

✨ Features

Code Snippet Management

• API Endpoint: /api/snippets
  • POST: Upload a new code snippet.
  • GET/{name}: Retrieve a code snippet by its name.

Documentation Generation

• API Endpoint: /api/snippets/wiki and /api/snippets/code-style
  • POST: Generate a project wiki and a code style guide respectively.

📦 Installation

MCP Configuration

Quick Creation of mcp.json

mkdir -p .vscode && cat > .vscode/mcp.json <<'EOF'
{
  "inputs": [
    {
      "type": "promptString",
      "id": "functions-mcp-extension-system-key",
      "description": "Azure Functions MCP system key",
      "password": true
    },
    {
      "type": "promptString",
      "id": "functionapp-name",
      "description": "Name of the deployed function app"
    }
  ],
  "servers": {
    "local-snippy": {
      "type": "sse",
      "url": "http://localhost:7071/runtime/webhooks/mcp/sse"
    },
    "remote-snippy": {
      "type": "sse",
      "url": "https://${input:functionapp-name}.azurewebsites.net/runtime/webhooks/mcp/sse",
      "headers": { "x-functions-key": "${input:functions-mcp-extension-system-key}" }
    }
  }
}
EOF

Retrieve the system key:

az functionapp keys list -g <Resource group name> -n <Function app name> --query [0].value

💻 Usage Examples

Saving a Code Snippet

Save a code snippet to cloud storage using the following command:

curl -X POST "http://localhost:7071/api/snippets" \
-H "Content-Type: text/plain" \
-d "<Your code snippet>"

Viewing a Code Snippet

Find and display a saved code snippet using the following command:

curl "http://localhost:7071/api/snippets/<Snippet name>" 

Generating a Wiki

Generate a project wiki using the following command:

curl -X POST "http://localhost:7071/api/snippets/wiki" \
-H "Content-Type: application/json" \
-d '{"title":"<Your title>", "content":"<Your content>"}'

Generating a Style Guide

Generate a code style guide using the following command:

curl -X POST "http://localhost:7173/api/snippets/code-style" \
-H "Content-Type: application/json" \
-d '{"language":"<Language>", "styles":"<Style description>"}'

Quick Deployment

Using Codespaces

Run the project on Codespaces by following these steps:

1. Open the project repository: Snippy.
2. Click the "Code" button and select "Open in Codespace".

📚 Documentation

How to Contribute

1. Fork the project repository.
2. Make modifications on your own branch.
3. Submit and create a Pull Request.

Coding Standards

• Follow the Microsoft Azure coding standards.
• Keep the code concise and maintainable.

Support and Feedback

Issue Reporting

If you have any issues or suggestions, please create an issue in the GitHub repository: Snippy Issues.

Community Support

Join our Discord community to exchange experiences with other developers.

🔧 Technical Details

Main Components

1. Azure Functions: Implement RESTful API interfaces to handle user requests.
2. Durable Functions: Handle asynchronous tasks (e.g., documentation generation).
3. Cosmos DB: Serve as the storage backend to save code snippets and metadata.
4. OpenAI Integration: Integrate the OpenAI API to generate natural language text (e.g., wikis and style guides).

Core Features

Code Snippet Management

• API Endpoint: /api/snippets
  • POST: Upload a new code snippet.
  • GET/{name}: Retrieve a code snippet by its name.

Documentation Generation

• API Endpoint: /api/snippets/wiki and /api/snippets/code-style
  • POST: Generate a project wiki and a code style guide respectively.

📄 License

This project is licensed under the MIT License.