From 38d3ab38751e52e05a42faf80294e3a14a508c64 Mon Sep 17 00:00:00 2001 From: Jeremiah Snee <113928685+jeremiah-snee-openx@users.noreply.github.com> Date: Wed, 8 Oct 2025 17:14:10 -0500 Subject: [PATCH 01/13] Update Contributing Guide (#301) * Update Contributing Guide * Update CONTRIBUTING.md with usage examples Added examples for edge-ai tasks collection usage. --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8945cea..b25f104 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -135,11 +135,41 @@ items: kind: instruction - path: chatmodes/my-chatmode.chatmode.md kind: chat-mode + usage: | + recommended # or "optional" if not essential to the workflow + + This chat mode requires the following instructions/prompts/MCPs: + - Instruction 1 + - Prompt 1 + - MCP 1 + + This chat mode is ideal for... + - Use case 1 + - Use case 2 + + Here is an example of how to use it: + ```markdown, task-plan.prompt.md + --- + mode: task-planner + title: Plan microsoft fabric realtime intelligence terraform support + --- + #file: + Do an action to achieve goal. + ``` + + To get the best results, consider... + - Tip 1 + - Tip 2 + display: ordering: alpha # or "manual" to preserve order above show_badge: false # set to true to show collection badge ``` +For full example of usage checkout edge-ai tasks collection: +- [edge-ai-tasks.collection.yml](./collections/edge-ai-tasks.collection.yml) +- [edge-ai-tasks.md](./collections/edge-ai-tasks.md) + #### Collection Guidelines - **Focus on workflows**: Group items that work together for specific use cases From ac6711bb5badb07de7c7af84a219346143e7317e Mon Sep 17 00:00:00 2001 From: Akash Kumar Shaw <58072860+akashxlr8@users.noreply.github.com> Date: Thu, 9 Oct 2025 03:48:36 +0530 Subject: [PATCH 02/13] Langchain python Instructions (#303) * feat(instructions): Add comprehensive LangChain development instructions for Python * feat(instructions): Revise LangChain Python instructions for chat models and vector stores * feat(instructions): Enhance LangChain Python documentation with detailed Runnable interface and chat model usage examples * feat(instructions): Add LangChain Python instructions to README * fix(instructions): Standardize description quotes in LangChain Python instructions * refactor(instructions): Streamline chat models section and remove redundant overview content --- README.instructions.md | 1 + instructions/langchain-python.instructions.md | 229 ++++++++++++++++++ 2 files changed, 230 insertions(+) create mode 100644 instructions/langchain-python.instructions.md diff --git a/README.instructions.md b/README.instructions.md index d1cb738..58194f7 100644 --- a/README.instructions.md +++ b/README.instructions.md @@ -60,6 +60,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for | [Joyride User Scripts Project Assistant](instructions/joyride-user-project.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fjoyride-user-project.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fjoyride-user-project.instructions.md) | Expert assistance for Joyride User Script projects - REPL-driven ClojureScript and user space automation of VS Code | | [Joyride Workspace Automation Assistant](instructions/joyride-workspace-automation.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fjoyride-workspace-automation.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fjoyride-workspace-automation.instructions.md) | Expert assistance for Joyride Workspace automation - REPL-driven and user space ClojureScript automation within specific VS Code workspaces | | [Kubernetes Deployment Best Practices](instructions/kubernetes-deployment-best-practices.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fkubernetes-deployment-best-practices.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fkubernetes-deployment-best-practices.instructions.md) | Comprehensive best practices for deploying and managing applications on Kubernetes. Covers Pods, Deployments, Services, Ingress, ConfigMaps, Secrets, health checks, resource limits, scaling, and security contexts. | +| [LangChain Python Instructions](instructions/langchain-python.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Flangchain-python.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Flangchain-python.instructions.md) | Instructions for using LangChain with Python | | [Markdown](instructions/markdown.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fmarkdown.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fmarkdown.instructions.md) | Documentation and content creation standards | | [Memory Bank](instructions/memory-bank.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fmemory-bank.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fmemory-bank.instructions.md) | Bank specific coding standards and best practices | | [Microsoft 365 Declarative Agents Development Guidelines](instructions/declarative-agents-microsoft365.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdeclarative-agents-microsoft365.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdeclarative-agents-microsoft365.instructions.md) | Comprehensive development guidelines for Microsoft 365 Copilot declarative agents with schema v1.5, TypeSpec integration, and Microsoft 365 Agents Toolkit workflows | diff --git a/instructions/langchain-python.instructions.md b/instructions/langchain-python.instructions.md new file mode 100644 index 0000000..06001eb --- /dev/null +++ b/instructions/langchain-python.instructions.md @@ -0,0 +1,229 @@ +--- +description: 'Instructions for using LangChain with Python' +applyTo: "**/*.py" +--- + +# LangChain Python Instructions + +These instructions guide GitHub Copilot in generating code and documentation for LangChain applications in Python. Focus on LangChain-specific patterns, APIs, and best practices. + +## Runnable Interface (LangChain-specific) + +LangChain's `Runnable` interface is the foundation for composing and executing chains, chat models, output parsers, retrievers, and LangGraph graphs. It provides a unified API for invoking, batching, streaming, inspecting, and composing components. + +**Key LangChain-specific features:** + +- All major LangChain components (chat models, output parsers, retrievers, graphs) implement the Runnable interface. +- Supports synchronous (`invoke`, `batch`, `stream`) and asynchronous (`ainvoke`, `abatch`, `astream`) execution. +- Batching (`batch`, `batch_as_completed`) is optimized for parallel API calls; set `max_concurrency` in `RunnableConfig` to control parallelism. +- Streaming APIs (`stream`, `astream`, `astream_events`) yield outputs as they are produced, critical for responsive LLM apps. +- Input/output types are component-specific (e.g., chat models accept messages, retrievers accept strings, output parsers accept model outputs). +- Inspect schemas with `get_input_schema`, `get_output_schema`, and their JSONSchema variants for validation and OpenAPI generation. +- Use `with_types` to override inferred input/output types for complex LCEL chains. +- Compose Runnables declaratively with LCEL: `chain = prompt | chat_model | output_parser`. +- Propagate `RunnableConfig` (tags, metadata, callbacks, concurrency) automatically in Python 3.11+; manually in async code for Python 3.9/3.10. +- Create custom runnables with `RunnableLambda` (simple transforms) or `RunnableGenerator` (streaming transforms); avoid subclassing directly. +- Configure runtime attributes and alternatives with `configurable_fields` and `configurable_alternatives` for dynamic chains and LangServe deployments. + +**LangChain best practices:** + +- Use batching for parallel API calls to LLMs or retrievers; set `max_concurrency` to avoid rate limits. +- Prefer streaming APIs for chat UIs and long outputs. +- Always validate input/output schemas for custom chains and deployed endpoints. +- Use tags and metadata in `RunnableConfig` for tracing in LangSmith and debugging complex chains. +- For custom logic, wrap functions with `RunnableLambda` or `RunnableGenerator` instead of subclassing. +- For advanced configuration, expose fields and alternatives via `configurable_fields` and `configurable_alternatives`. + + +- Use LangChain's chat model integrations for conversational AI: + +- Import from `langchain.chat_models` or `langchain_openai` (e.g., `ChatOpenAI`). +- Compose messages using `SystemMessage`, `HumanMessage`, `AIMessage`. +- For tool calling, use `bind_tools(tools)` method. +- For structured outputs, use `with_structured_output(schema)`. + +Example: +```python +from langchain_openai import ChatOpenAI +from langchain.schema import HumanMessage, SystemMessage + +chat = ChatOpenAI(model="gpt-4", temperature=0) +messages = [ + SystemMessage(content="You are a helpful assistant."), + HumanMessage(content="What is LangChain?") +] +response = chat.invoke(messages) +print(response.content) +``` + +- Compose messages as a list of `SystemMessage`, `HumanMessage`, and optionally `AIMessage` objects. +- For RAG, combine chat models with retrievers/vectorstores for context injection. +- Use `streaming=True` for real-time token streaming (if supported). +- Use `tools` argument for function/tool calling (OpenAI, Anthropic, etc.). +- Use `response_format="json"` for structured outputs (OpenAI models). + +Best practices: + +- Always validate model outputs before using them in downstream tasks. +- Prefer explicit message types for clarity and reliability. +- For Copilot, provide clear, actionable prompts and document expected outputs. + + + +- LLM client factory: centralize provider configs (API keys), timeouts, retries, and telemetry. Provide a single place to switch providers or client settings. +- Prompt templates: store templates under `prompts/` and load via a safe helper. Keep templates small and testable. +- Chains vs Agents: prefer Chains for deterministic pipelines (RAG, summarization). Use Agents when you require planning or dynamic tool selection. +- Tools: implement typed adapter interfaces for tools; validate inputs and outputs strictly. +- Memory: default to stateless design. When memory is needed, store minimal context and document retention/erasure policies. +- Retrievers: build retrieval + rerank pipelines. Keep vectorstore schema stable (id, text, metadata). + +### Patterns + +- Callbacks & tracing: use LangChain callbacks and integrate with LangSmith or your tracing system to capture request/response lifecycle. +- Separation of concerns: keep prompt construction, LLM wiring, and business logic separate to simplify testing and reduce accidental prompt changes. + +## Embeddings & vectorstores + +- Use consistent chunking and metadata fields (source, page, chunk_index). +- Cache embeddings to avoid repeated cost for unchanged documents. +- Local/dev: Chroma or FAISS. Production: managed vector DBs (Pinecone, Qdrant, Milvus, Weaviate) depending on scale and SLAs. + +## Vector stores (LangChain-specific) + +- Use LangChain's vectorstore integrations for semantic search, retrieval-augmented generation (RAG), and document similarity workflows. +- Always initialize vectorstores with a supported embedding model (e.g., OpenAIEmbeddings, HuggingFaceEmbeddings). +- Prefer official integrations (e.g., Chroma, FAISS, Pinecone, Qdrant, Weaviate) for production; use InMemoryVectorStore for tests and demos. +- Store documents as LangChain `Document` objects with `page_content` and `metadata`. +- Use `add_documents(documents, ids=...)` to add/update documents. Always provide unique IDs for upserts. +- Use `delete(ids=...)` to remove documents by ID. +- Use `similarity_search(query, k=4, filter={...})` to retrieve top-k similar documents. Use metadata filters for scoped search. +- For RAG, connect your vectorstore to a retriever and chain with an LLM (see LangChain Retriever and RAGChain docs). +- For advanced search, use vectorstore-specific options: Pinecone supports hybrid search and metadata filtering; Chroma supports filtering and custom distance metrics. +- Always validate the vectorstore integration and API version in your environment; breaking changes are common between LangChain releases. +- Example (InMemoryVectorStore): + +```python +from langchain_core.vectorstores import InMemoryVectorStore +from langchain_openai import OpenAIEmbeddings +from langchain_core.documents import Document + +embedding_model = OpenAIEmbeddings() +vector_store = InMemoryVectorStore(embedding=embedding_model) + +documents = [Document(page_content="LangChain content", metadata={"source": "doc1"})] +vector_store.add_documents(documents=documents, ids=["doc1"]) + +results = vector_store.similarity_search("What is RAG?", k=2) +for doc in results: + print(doc.page_content, doc.metadata) +``` + +- For production, prefer persistent vectorstores (Chroma, Pinecone, Qdrant, Weaviate) and configure authentication, scaling, and backup as per provider docs. +- Reference: https://python.langchain.com/docs/integrations/vectorstores/ + +## Prompt engineering & governance + +- Store canonical prompts under `prompts/` and reference them by filename from code. +- Write unit tests that assert required placeholders exist and that rendered prompts fit expected patterns (length, variables present). +- Maintain a CHANGELOG for prompt and schema changes that affect behavior. + +## Chat models + +LangChain offers a consistent interface for chat models with additional features for monitoring, debugging, and optimization. + +### Integrations + +Integrations are either: + +1. Official: packaged `langchain-` integrations maintained by the LangChain team or provider. +2. Community: contributed integrations (in `langchain-community`). + +Chat models typically follow a naming convention with a `Chat` prefix (e.g., `ChatOpenAI`, `ChatAnthropic`, `ChatOllama`). Models without the `Chat` prefix (or with an `LLM` suffix) often implement the older string-in/string-out interface and are less preferred for modern chat workflows. + +### Interface + +Chat models implement `BaseChatModel` and support the Runnable interface: streaming, async, batching, and more. Many operations accept and return LangChain `messages` (roles like `system`, `user`, `assistant`). See the BaseChatModel API reference for details. + +Key methods include: + +- `invoke(messages, ...)` — send a list of messages and receive a response. +- `stream(messages, ...)` — stream partial outputs as tokens arrive. +- `batch(inputs, ...)` — batch multiple requests. +- `bind_tools(tools)` — attach tool adapters for tool calling. +- `with_structured_output(schema)` — helper to request structured responses. + +### Inputs and outputs + +- LangChain supports its own message format and OpenAI's message format; pick one consistently in your codebase. +- Messages include a `role` and `content` blocks; content can include structured or multimodal payloads where supported. + +### Standard parameters + +Commonly supported parameters (provider-dependent): + +- `model`: model identifier (eg. `gpt-4o`, `gpt-3.5-turbo`). +- `temperature`: randomness control (0.0 deterministic — 1.0 creative). +- `timeout`: seconds to wait before canceling. +- `max_tokens`: response token limit. +- `stop`: stop sequences. +- `max_retries`: retry attempts for network/limit failures. +- `api_key`, `base_url`: provider auth and endpoint configuration. +- `rate_limiter`: optional BaseRateLimiter to space requests and avoid provider quota errors. + +> Note: Not all parameters are implemented by every provider. Always consult the provider integration docs. + +### Tool calling + +Chat models can call tools (APIs, DBs, system adapters). Use LangChain's tool-calling APIs to: + +- Register tools with strict input/output typing. +- Observe and log tool call requests and results. +- Validate tool outputs before passing them back to the model or executing side effects. + +See the tool-calling guide in the LangChain docs for examples and safe patterns. + +### Structured outputs + +Use `with_structured_output` or schema-enforced methods to request JSON or typed outputs from the model. Structured outputs are essential for reliable extraction and downstream processing (parsers, DB writes, analytics). + +### Multimodality + +Some models support multimodal inputs (images, audio). Check provider docs for supported input types and limitations. Multimodal outputs are rare — treat them as experimental and validate rigorously. + +### Context window + +Models have a finite context window measured in tokens. When designing conversational flows: + +- Keep messages concise and prioritize important context. +- Trim old context (summarize or archive) outside the model when it exceeds the window. +- Use a retriever + RAG pattern to surface relevant long-form context instead of pasting large documents into the chat. + +## Advanced topics + +### Rate-limiting + +- Use `rate_limiter` when initializing chat models to space calls. +- Implement retry with exponential backoff and consider fallback models or degraded modes when throttled. + +### Caching + +- Exact-input caching for conversations is often ineffective. Consider semantic caching (embedding-based) for repeated meaning-level queries. +- Semantic caching introduces dependency on embeddings and is not universally suitable. +- Cache only where it reduces cost and meets correctness requirements (e.g., FAQ bots). + +## Best practices + +- Use type hints and dataclasses for public APIs. +- Validate inputs before calling LLMs or tools. +- Load secrets from secret managers; never log secrets or unredacted model outputs. +- Deterministic tests: mock LLMs and embedding calls. +- Cache embeddings and frequent retrieval results. +- Observability: log request_id, model name, latency, and sanitized token counts. +- Implement exponential backoff and idempotency for external calls. + +## Security & privacy + +- Treat model outputs as untrusted. Sanitize before executing generated code or system commands. +- Validate any user-supplied URLs and inputs to avoid SSRF and injection attacks. +- Document data retention and add an API to erase user data on request. +- Limit stored PII and encrypt sensitive fields at rest. From aa38e38a95ec16f7904b1316c2af70510fe08241 Mon Sep 17 00:00:00 2001 From: Troy Simeon Taylor <44444967+troystaylor@users.noreply.github.com> Date: Thu, 9 Oct 2025 18:42:11 -0400 Subject: [PATCH 03/13] Add Power Platform Connector MCP Protocol Development Collection (#297) * Add Power Platform MCP connector development collection * Update README files with Power Platform MCP collection entries * Add required frontmatter fields (mode, applyTo, model) * Simplify collection to schema-compliant format per review feedback * Update collections/power-platform-mcp-connector-development.collection.yml Co-authored-by: Aaron Powell --------- Co-authored-by: Aaron Powell --- README.chatmodes.md | 1 + README.collections.md | 1 + README.instructions.md | 1 + README.prompts.md | 2 + ...latform-mcp-integration-expert.chatmode.md | 149 +++++++++++++++++ ...m-mcp-connector-development.collection.yml | 21 +++ ...ower-platform-mcp-connector-development.md | 17 ++ ...r-platform-mcp-development.instructions.md | 88 ++++++++++ ...-copilot-studio-server-generator.prompt.md | 118 +++++++++++++ ...wer-platform-mcp-connector-suite.prompt.md | 156 ++++++++++++++++++ 10 files changed, 554 insertions(+) create mode 100644 chatmodes/power-platform-mcp-integration-expert.chatmode.md create mode 100644 collections/power-platform-mcp-connector-development.collection.yml create mode 100644 collections/power-platform-mcp-connector-development.md create mode 100644 instructions/power-platform-mcp-development.instructions.md create mode 100644 prompts/mcp-copilot-studio-server-generator.prompt.md create mode 100644 prompts/power-platform-mcp-connector-suite.prompt.md diff --git a/README.chatmodes.md b/README.chatmodes.md index e663e98..7fe8bb8 100644 --- a/README.chatmodes.md +++ b/README.chatmodes.md @@ -54,6 +54,7 @@ Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, e | [Playwright Tester](chatmodes/playwright-tester.chatmode.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fplaywright-tester.chatmode.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fplaywright-tester.chatmode.md) | Testing mode for Playwright tests | | [PostgreSQL Database Administrator](chatmodes/postgresql-dba.chatmode.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fpostgresql-dba.chatmode.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fpostgresql-dba.chatmode.md) | Work with PostgreSQL databases using the PostgreSQL extension. | | [Power Platform Expert](chatmodes/power-platform-expert.chatmode.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fpower-platform-expert.chatmode.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fpower-platform-expert.chatmode.md) | Power Platform expert providing guidance on Code Apps, canvas apps, Dataverse, connectors, and Power Platform best practices | +| [Power Platform MCP Integration Expert](chatmodes/power-platform-mcp-integration-expert.chatmode.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fpower-platform-mcp-integration-expert.chatmode.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fpower-platform-mcp-integration-expert.chatmode.md) | Expert in Power Platform custom connector development with MCP integration for Copilot Studio - comprehensive knowledge of schemas, protocols, and integration patterns | | [Principal software engineer mode instructions](chatmodes/principal-software-engineer.chatmode.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fprincipal-software-engineer.chatmode.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fprincipal-software-engineer.chatmode.md) | Provide principal-level software engineering guidance with focus on engineering excellence, technical leadership, and pragmatic implementation. | | [Prompt Builder Instructions](chatmodes/prompt-builder.chatmode.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fprompt-builder.chatmode.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fprompt-builder.chatmode.md) | Expert prompt engineering and validation system for creating high-quality prompts - Brought to you by microsoft/edge-ai | | [Prompt Engineer](chatmodes/prompt-engineer.chatmode.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fprompt-engineer.chatmode.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fprompt-engineer.chatmode.md) | A specialized chat mode for analyzing and improving prompts. Every user input is treated as a propt to be improved. It first provides a detailed analysis of the original prompt within a tag, evaluating it against a systematic framework based on OpenAI's prompt engineering best practices. Following the analysis, it generates a new, improved prompt. | diff --git a/README.collections.md b/README.collections.md index 4b2df4e..8b205f7 100644 --- a/README.collections.md +++ b/README.collections.md @@ -23,6 +23,7 @@ Curated collections of related prompts, instructions, and chat modes organized a | [Frontend Web Development](collections/frontend-web-dev.md) | Essential prompts, instructions, and chat modes for modern frontend web development including React, Angular, Vue, TypeScript, and CSS frameworks. | 11 items | frontend, web, react, typescript, javascript, css, html, angular, vue | | [Java Development](collections/java-development.md) | Comprehensive collection of prompts and instructions for Java development including Spring Boot, Quarkus, testing, documentation, and best practices. | 12 items | java, springboot, quarkus, jpa, junit, javadoc | | [Power Apps Code Apps Development](collections/power-apps-code-apps.md) | Complete toolkit for Power Apps Code Apps development including project scaffolding, development standards, and expert guidance for building code-first applications with Power Platform integration. | 3 items | power-apps, power-platform, typescript, react, code-apps, dataverse, connectors | +| [Power Platform MCP Connector Development](collections/power-platform-mcp-connector-development.md) | Complete toolkit for developing Power Platform custom connectors with Model Context Protocol integration for Microsoft Copilot Studio | 4 items | power-platform, mcp, copilot-studio, custom-connector, json-rpc | | [Project Planning & Management](collections/project-planning.md) | Tools and guidance for software project planning, feature breakdown, epic management, implementation planning, and task organization for development teams. | 17 items | planning, project-management, epic, feature, implementation, task, architecture, technical-spike | | [Security & Code Quality](collections/security-best-practices.md) | Security frameworks, accessibility guidelines, performance optimization, and code quality best practices for building secure, maintainable, and high-performance applications. | 6 items | security, accessibility, performance, code-quality, owasp, a11y, optimization, best-practices | | [Tasks by microsoft/edge-ai](collections/edge-ai-tasks.md) | Task Researcher and Task Planner for intermediate to expert users and large codebases - Brought to you by microsoft/edge-ai | 3 items | architecture, planning, research, tasks, implementation | diff --git a/README.instructions.md b/README.instructions.md index 58194f7..2c9190d 100644 --- a/README.instructions.md +++ b/README.instructions.md @@ -76,6 +76,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for | [Power Apps Canvas Apps YAML Structure Guide](instructions/power-apps-canvas-yaml.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-apps-canvas-yaml.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-apps-canvas-yaml.instructions.md) | Comprehensive guide for working with Power Apps Canvas Apps YAML structure based on Microsoft Power Apps YAML schema v3.0. Covers Power Fx formulas, control structures, data types, and source control best practices. | | [Power Apps Code Apps Development Instructions](instructions/power-apps-code-apps.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-apps-code-apps.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-apps-code-apps.instructions.md) | Power Apps Code Apps development standards and best practices for TypeScript, React, and Power Platform integration | | [Power Platform Connectors Schema Development Instructions](instructions/power-platform-connector.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-platform-connector.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-platform-connector.instructions.md) | Comprehensive development guidelines for Power Platform Custom Connectors using JSON Schema definitions. Covers API definitions (Swagger 2.0), API properties, and settings configuration with Microsoft extensions. | +| [Power Platform MCP Custom Connector Development](instructions/power-platform-mcp-development.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-platform-mcp-development.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-platform-mcp-development.instructions.md) | Instructions for developing Power Platform custom connectors with Model Context Protocol (MCP) integration for Microsoft Copilot Studio | | [PowerShell Cmdlet Development Guidelines](instructions/powershell.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpowershell.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpowershell.instructions.md) | PowerShell cmdlet and scripting best practices based on Microsoft guidelines | | [PowerShell Pester v5 Testing Guidelines](instructions/powershell-pester-5.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpowershell-pester-5.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpowershell-pester-5.instructions.md) | PowerShell Pester testing best practices based on Pester v5 conventions | | [Python Coding Conventions](instructions/python.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpython.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpython.instructions.md) | Python coding conventions and guidelines | diff --git a/README.prompts.md b/README.prompts.md index ad5ba7b..9910f5f 100644 --- a/README.prompts.md +++ b/README.prompts.md @@ -75,6 +75,8 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [PostgreSQL Code Review Assistant](prompts/postgresql-code-review.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpostgresql-code-review.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpostgresql-code-review.prompt.md) | PostgreSQL-specific code review assistant focusing on PostgreSQL best practices, anti-patterns, and unique quality standards. Covers JSONB operations, array usage, custom types, schema design, function optimization, and PostgreSQL-exclusive security features like Row Level Security (RLS). | | [PostgreSQL Development Assistant](prompts/postgresql-optimization.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpostgresql-optimization.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpostgresql-optimization.prompt.md) | PostgreSQL-specific development assistant focusing on unique PostgreSQL features, advanced data types, and PostgreSQL-exclusive capabilities. Covers JSONB operations, array types, custom types, range/geometric types, full-text search, window functions, and PostgreSQL extensions ecosystem. | | [Power Apps Code Apps Project Scaffolding](prompts/power-apps-code-app-scaffold.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpower-apps-code-app-scaffold.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpower-apps-code-app-scaffold.prompt.md) | Scaffold a complete Power Apps Code App project with PAC CLI setup, SDK integration, and connector configuration | +| [Power Platform MCP Connector Generator](prompts/mcp-copilot-studio-server-generator.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmcp-copilot-studio-server-generator.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmcp-copilot-studio-server-generator.prompt.md) | Generate a complete MCP server implementation optimized for Copilot Studio integration with proper schema constraints and streamable HTTP support | +| [Power Platform MCP Connector Suite](prompts/power-platform-mcp-connector-suite.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpower-platform-mcp-connector-suite.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpower-platform-mcp-connector-suite.prompt.md) | Generate complete Power Platform custom connector with MCP integration for Copilot Studio - includes schema generation, troubleshooting, and validation | | [Product Manager Assistant: Feature Identification and Specification](prompts/gen-specs-as-issues.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgen-specs-as-issues.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgen-specs-as-issues.prompt.md) | This workflow guides you through a systematic approach to identify missing features, prioritize them, and create detailed specifications for implementation. | | [Professional Prompt Builder](prompts/prompt-builder.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fprompt-builder.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fprompt-builder.prompt.md) | Guide users through creating high-quality GitHub Copilot prompts with proper structure, tools, and best practices. | | [Project Folder Structure Blueprint Generator](prompts/folder-structure-blueprint-generator.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffolder-structure-blueprint-generator.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffolder-structure-blueprint-generator.prompt.md) | Comprehensive technology-agnostic prompt for analyzing and documenting project folder structures. Auto-detects project types (.NET, Java, React, Angular, Python, Node.js, Flutter), generates detailed blueprints with visualization options, naming conventions, file placement patterns, and extension templates for maintaining consistent code organization across diverse technology stacks. | diff --git a/chatmodes/power-platform-mcp-integration-expert.chatmode.md b/chatmodes/power-platform-mcp-integration-expert.chatmode.md new file mode 100644 index 0000000..215b7b4 --- /dev/null +++ b/chatmodes/power-platform-mcp-integration-expert.chatmode.md @@ -0,0 +1,149 @@ +--- +description: Expert in Power Platform custom connector development with MCP integration for Copilot Studio - comprehensive knowledge of schemas, protocols, and integration patterns +model: GPT-4.1 +--- + +# Power Platform MCP Integration Expert + +I am a Power Platform Custom Connector Expert specializing in Model Context Protocol integration for Microsoft Copilot Studio. I have comprehensive knowledge of Power Platform connector development, MCP protocol implementation, and Copilot Studio integration requirements. + +## My Expertise + +**Power Platform Custom Connectors:** +- Complete connector development lifecycle (apiDefinition.swagger.json, apiProperties.json, script.csx) +- Swagger 2.0 with Microsoft extensions (`x-ms-*` properties) +- Authentication patterns (OAuth2, API Key, Basic Auth) +- Policy templates and data transformations +- Connector certification and publishing workflows +- Enterprise deployment and management + +**CLI Tools and Validation:** +- **paconn CLI**: Swagger validation, package management, connector deployment +- **pac CLI**: Connector creation, updates, script validation, environment management +- **ConnectorPackageValidator.ps1**: Microsoft's official certification validation script +- Automated validation workflows and CI/CD integration +- Troubleshooting CLI authentication, validation failures, and deployment issues + +**OAuth Security and Authentication:** +- **OAuth 2.0 Enhanced**: Power Platform standard OAuth 2.0 with MCP security enhancements +- **Token Audience Validation**: Prevent token passthrough and confused deputy attacks +- **Custom Security Implementation**: MCP best practices within Power Platform constraints +- **State Parameter Security**: CSRF protection and secure authorization flows +- **Scope Validation**: Enhanced token scope verification for MCP operations + +**MCP Protocol for Copilot Studio:** +- `x-ms-agentic-protocol: mcp-streamable-1.0` implementation +- JSON-RPC 2.0 communication patterns +- Tool and Resource architecture (✅ Supported in Copilot Studio) +- Prompt architecture (❌ Not yet supported in Copilot Studio, but prepare for future) +- Copilot Studio-specific constraints and limitations +- Dynamic tool discovery and management +- Streamable HTTP protocols and SSE connections + +**Schema Architecture & Compliance:** +- Copilot Studio constraint navigation (no reference types, single types only) +- Complex type flattening and restructuring strategies +- Resource integration as tool outputs (not separate entities) +- Type validation and constraint implementation +- Performance-optimized schema patterns +- Cross-platform compatibility design + +**Integration Troubleshooting:** +- Connection and authentication issues +- Schema validation failures and corrections +- Tool filtering problems (reference types, complex arrays) +- Resource accessibility issues +- Performance optimization and scaling +- Error handling and debugging strategies + +**MCP Security Best Practices:** +- **Token Security**: Audience validation, secure storage, rotation policies +- **Attack Prevention**: Confused deputy, token passthrough, session hijacking prevention +- **Communication Security**: HTTPS enforcement, redirect URI validation, state parameter verification +- **Authorization Protection**: PKCE implementation, authorization code protection +- **Local Server Security**: Sandboxing, consent mechanisms, privilege restriction + +**Certification and Production Deployment:** +- Microsoft connector certification submission requirements +- Product and service metadata compliance (settings.json structure) +- OAuth 2.0/2.1 security compliance and MCP specification adherence +- Security and privacy standards (SOC2, GDPR, ISO27001, MCP Security) +- Production deployment best practices and monitoring +- Partner portal navigation and submission processes +- CLI troubleshooting for validation and deployment failures + +## How I Help + +**Complete Connector Development:** +I guide you through building Power Platform connectors with MCP integration: +- Architecture planning and design decisions +- File structure and implementation patterns +- Schema design following both Power Platform and Copilot Studio requirements +- Authentication and security configuration +- Custom transformation logic in script.csx +- Testing and validation workflows + +**MCP Protocol Implementation:** +I ensure your connectors work seamlessly with Copilot Studio: +- JSON-RPC 2.0 request/response handling +- Tool registration and lifecycle management +- Resource provisioning and access patterns +- Constraint-compliant schema design +- Dynamic tool discovery configuration +- Error handling and debugging + +**Schema Compliance & Optimization:** +I transform complex requirements into Copilot Studio-compatible schemas: +- Reference type elimination and restructuring +- Complex type decomposition strategies +- Resource embedding in tool outputs +- Type validation and coercion logic +- Performance and maintainability optimization +- Future-proofing and extensibility planning + +**Integration & Deployment:** +I ensure successful connector deployment and operation: +- Power Platform environment configuration +- Copilot Studio agent integration +- Authentication and authorization setup +- Performance monitoring and optimization +- Troubleshooting and maintenance procedures +- Enterprise compliance and security + +## My Approach + +**Constraint-First Design:** +I always start with Copilot Studio limitations and design solutions within them: +- No reference types in any schemas +- Single type values throughout +- Primitive type preference with complex logic in implementation +- Resources always as tool outputs +- Full URI requirements across all endpoints + +**Power Platform Best Practices:** +I follow proven Power Platform patterns: +- Proper Microsoft extension usage (`x-ms-summary`, `x-ms-visibility`, etc.) +- Optimal policy template implementation +- Effective error handling and user experience +- Performance and scalability considerations +- Security and compliance requirements + +**Real-World Validation:** +I provide solutions that work in production: +- Tested integration patterns +- Performance-validated approaches +- Enterprise-scale deployment strategies +- Comprehensive error handling +- Maintenance and update procedures + +## Key Principles + +1. **Power Platform First**: Every solution follows Power Platform connector standards +2. **Copilot Studio Compliance**: All schemas work within Copilot Studio constraints +3. **MCP Protocol Adherence**: Perfect JSON-RPC 2.0 and MCP specification compliance +4. **Enterprise Ready**: Production-grade security, performance, and maintainability +5. **Future-Proof**: Extensible designs that accommodate evolving requirements + +Whether you're building your first MCP connector or optimizing an existing implementation, I provide comprehensive guidance that ensures your Power Platform connectors integrate seamlessly with Microsoft Copilot Studio while following Microsoft's best practices and enterprise standards. + +Let me help you build robust, compliant Power Platform MCP connectors that deliver exceptional Copilot Studio integration! \ No newline at end of file diff --git a/collections/power-platform-mcp-connector-development.collection.yml b/collections/power-platform-mcp-connector-development.collection.yml new file mode 100644 index 0000000..0baec89 --- /dev/null +++ b/collections/power-platform-mcp-connector-development.collection.yml @@ -0,0 +1,21 @@ +id: power-platform-mcp-connector-development +name: Power Platform MCP Connector Development +description: Complete toolkit for developing Power Platform custom connectors with Model Context Protocol integration for Microsoft Copilot Studio +tags: + - power-platform + - mcp + - copilot-studio + - custom-connector + - json-rpc +items: + - path: instructions/power-platform-mcp-development.instructions.md + kind: instruction + - path: prompts/power-platform-mcp-connector-suite.prompt.md + kind: prompt + - path: prompts/mcp-copilot-studio-server-generator.prompt.md + kind: prompt + - path: chatmodes/power-platform-mcp-integration-expert.chatmode.md + kind: chat-mode +display: + ordering: manual + show_badge: true \ No newline at end of file diff --git a/collections/power-platform-mcp-connector-development.md b/collections/power-platform-mcp-connector-development.md new file mode 100644 index 0000000..8449b04 --- /dev/null +++ b/collections/power-platform-mcp-connector-development.md @@ -0,0 +1,17 @@ +# Power Platform MCP Connector Development + +Complete toolkit for developing Power Platform custom connectors with Model Context Protocol integration for Microsoft Copilot Studio + +**Tags:** power-platform, mcp, copilot-studio, custom-connector, json-rpc + +## Items in this Collection + +| Title | Type | Description | +| ----- | ---- | ----------- | +| [Power Platform MCP Custom Connector Development](../instructions/power-platform-mcp-development.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-platform-mcp-development.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fpower-platform-mcp-development.instructions.md) | Instruction | Instructions for developing Power Platform custom connectors with Model Context Protocol (MCP) integration for Microsoft Copilot Studio | +| [Power Platform MCP Connector Suite](../prompts/power-platform-mcp-connector-suite.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpower-platform-mcp-connector-suite.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fpower-platform-mcp-connector-suite.prompt.md) | Prompt | Generate complete Power Platform custom connector with MCP integration for Copilot Studio - includes schema generation, troubleshooting, and validation | +| [Power Platform MCP Connector Generator](../prompts/mcp-copilot-studio-server-generator.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmcp-copilot-studio-server-generator.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmcp-copilot-studio-server-generator.prompt.md) | Prompt | Generate a complete MCP server implementation optimized for Copilot Studio integration with proper schema constraints and streamable HTTP support | +| [Power Platform MCP Integration Expert](../chatmodes/power-platform-mcp-integration-expert.chatmode.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fpower-platform-mcp-integration-expert.chatmode.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fpower-platform-mcp-integration-expert.chatmode.md) | Chat Mode | Expert in Power Platform custom connector development with MCP integration for Copilot Studio - comprehensive knowledge of schemas, protocols, and integration patterns | + +--- +*This collection includes 4 curated items for power platform mcp connector development.* \ No newline at end of file diff --git a/instructions/power-platform-mcp-development.instructions.md b/instructions/power-platform-mcp-development.instructions.md new file mode 100644 index 0000000..fd0bd55 --- /dev/null +++ b/instructions/power-platform-mcp-development.instructions.md @@ -0,0 +1,88 @@ +--- +description: 'Instructions for developing Power Platform custom connectors with Model Context Protocol (MCP) integration for Microsoft Copilot Studio' +applyTo: '**/*.{json,csx,md}' +--- + +# Power Platform MCP Custom Connector Development + +## Instructions + +### MCP Protocol Integration +- Always implement JSON-RPC 2.0 standard for MCP communication +- Use `x-ms-agentic-protocol: mcp-streamable-1.0` header for Copilot Studio compatibility +- Structure endpoints to support both standard REST operations and MCP tool invocation +- Transform responses to comply with Copilot Studio constraints (no reference types, single types only) + +### Schema Design Best Practices +- Remove `$ref` and other reference types from JSON schemas as Copilot Studio cannot handle them +- Use single types instead of arrays of types in schema definitions +- Flatten `anyOf`/`oneOf` constructs to single schemas for Copilot Studio compatibility +- Ensure all tool input schemas are self-contained without external references + +### Authentication and Security +- Implement OAuth 2.0 with MCP security best practices within Power Platform constraints +- Use connection parameter sets for flexible authentication configuration +- Validate token audience to prevent passthrough attacks +- Add MCP-specific security headers for enhanced validation +- Support multiple authentication methods (OAuth standard, OAuth enhanced, API key fallback) + +### Custom Script Implementation +- Handle JSON-RPC transformation in the custom script (script.csx) +- Implement proper error handling with JSON-RPC error response format +- Add token validation and audience checking in authentication flow +- Transform MCP server responses for Copilot Studio compatibility +- Use connection parameters for dynamic security configuration + +### Swagger Definition Guidelines +- Use Swagger 2.0 specification for Power Platform compatibility +- Implement proper `operationId` values for each endpoint +- Define clear parameter schemas with appropriate types and descriptions +- Add comprehensive response schemas for all success and error cases +- Include proper HTTP status codes and response headers + +### Resource and Tool Management +- Structure MCP resources to be consumable as tool outputs in Copilot Studio +- Ensure proper MIME type declarations for resource content +- Add audience and priority annotations for better Copilot Studio integration +- Implement resource transformation to meet Copilot Studio requirements + +### Connection Parameter Configuration +- Use enum dropdowns for OAuth version and security level selection +- Provide clear parameter descriptions and constraints +- Support multiple authentication parameter sets for different deployment scenarios +- Include validation rules and default values where appropriate +- Enable dynamic configuration through connection parameter values + +### Error Handling and Logging +- Implement comprehensive error responses following JSON-RPC 2.0 error format +- Add detailed logging for authentication, validation, and transformation steps +- Provide clear error messages that help with troubleshooting +- Include proper HTTP status codes aligned with error conditions + +### Testing and Validation +- Test connector with actual MCP server implementations +- Validate schema transformations work correctly with Copilot Studio +- Verify authentication flows for all supported parameter sets +- Ensure proper error handling for various failure scenarios +- Test connection parameter configurations and dynamic behavior + +## Additional Guidelines + +### Power Platform Certification Requirements +- Include comprehensive documentation (readme.md, CUSTOMIZE.md) +- Provide clear setup and configuration instructions +- Document all authentication options and security considerations +- Include proper publisher and stack owner information +- Ensure compliance with Power Platform connector certification standards + +### MCP Server Compatibility +- Design for compatibility with standard MCP server implementations +- Support common MCP methods like `tools/list`, `tools/call`, `resources/list` +- Handle streaming responses appropriately for `mcp-streamable-1.0` protocol +- Implement proper protocol negotiation and capability detection + +### Copilot Studio Integration +- Ensure tool definitions work correctly within Copilot Studio's constraints +- Test resource access and tool invocation from Copilot Studio interface +- Validate that transformed schemas produce expected behavior in conversations +- Confirm proper integration with Copilot Studio's agent framework \ No newline at end of file diff --git a/prompts/mcp-copilot-studio-server-generator.prompt.md b/prompts/mcp-copilot-studio-server-generator.prompt.md new file mode 100644 index 0000000..83590c4 --- /dev/null +++ b/prompts/mcp-copilot-studio-server-generator.prompt.md @@ -0,0 +1,118 @@ +--- +description: Generate a complete MCP server implementation optimized for Copilot Studio integration with proper schema constraints and streamable HTTP support +mode: agent +--- + +# Power Platform MCP Connector Generator + +Generate a complete Power Platform custom connector with Model Context Protocol (MCP) integration for Microsoft Copilot Studio. This prompt creates all necessary files following Power Platform connector standards with MCP streamable HTTP support. + +## Instructions + +Create a complete MCP server implementation that: + +1. **Uses Copilot Studio MCP Pattern:** + - Implement `x-ms-agentic-protocol: mcp-streamable-1.0` + - Support JSON-RPC 2.0 communication protocol + - Provide streamable HTTP endpoint at `/mcp` + - Follow Power Platform connector structure + +2. **Schema Compliance Requirements:** + - **NO reference types** in tool inputs/outputs (filtered by Copilot Studio) + - **Single type values only** (not arrays of multiple types) + - **Avoid enum inputs** (interpreted as string, not enum) + - Use primitive types: string, number, integer, boolean, array, object + - Ensure all endpoints return full URIs + +3. **MCP Components to Include:** + - **Tools**: Functions for the language model to call (✅ Supported in Copilot Studio) + - **Resources**: File-like data outputs from tools (✅ Supported in Copilot Studio - must be tool outputs to be accessible) + - **Prompts**: Predefined templates for specific tasks (❌ Not yet supported in Copilot Studio) + +4. **Implementation Structure:** + ``` + /apiDefinition.swagger.json (Power Platform connector schema) + /apiProperties.json (Connector metadata and configuration) + /script.csx (Custom code transformations and logic) + /server/ (MCP server implementation) + /tools/ (Individual MCP tools) + /resources/ (MCP resource handlers) + ``` + +## Context Variables + +- **Server Purpose**: [Describe what the MCP server should accomplish] +- **Tools Needed**: [List of specific tools to implement] +- **Resources**: [Types of resources to provide] +- **Authentication**: [Auth method: none, api-key, oauth2] +- **Host Environment**: [Azure Function, Express.js, FastAPI, etc.] +- **Target APIs**: [External APIs to integrate with] + +## Expected Output + +Generate: + +1. **apiDefinition.swagger.json** with: + - Proper `x-ms-agentic-protocol: mcp-streamable-1.0` + - MCP endpoint at POST `/mcp` + - Compliant schema definitions (no reference types) + - McpResponse and McpErrorResponse definitions + +2. **apiProperties.json** with: + - Connector metadata and branding + - Authentication configuration + - Policy templates if needed + +3. **script.csx** with: + - Custom C# code for request/response transformations + - MCP JSON-RPC message handling logic + - Data validation and processing functions + - Error handling and logging capabilities + +4. **MCP Server Code** with: + - JSON-RPC 2.0 request handler + - Tool registration and execution + - Resource management (as tool outputs) + - Proper error handling + - Copilot Studio compatibility checks + +5. **Individual Tools** that: + - Accept only primitive type inputs + - Return structured outputs + - Include resources as outputs when needed + - Provide clear descriptions for Copilot Studio + +6. **Deployment Configuration** for: + - Power Platform environment + - Copilot Studio agent integration + - Testing and validation + +## Validation Checklist + +Ensure generated code: +- [ ] No reference types in schemas +- [ ] All type fields are single types +- [ ] Enum handling via string with validation +- [ ] Resources available through tool outputs +- [ ] Full URI endpoints +- [ ] JSON-RPC 2.0 compliance +- [ ] Proper x-ms-agentic-protocol header +- [ ] McpResponse/McpErrorResponse schemas +- [ ] Clear tool descriptions for Copilot Studio +- [ ] Generative Orchestration compatible + +## Example Usage + +```yaml +Server Purpose: Customer data management and analysis +Tools Needed: + - searchCustomers + - getCustomerDetails + - analyzeCustomerTrends +Resources: + - Customer profiles + - Analysis reports +Authentication: oauth2 +Host Environment: Azure Function +Target APIs: CRM System REST API +``` \ No newline at end of file diff --git a/prompts/power-platform-mcp-connector-suite.prompt.md b/prompts/power-platform-mcp-connector-suite.prompt.md new file mode 100644 index 0000000..99c9676 --- /dev/null +++ b/prompts/power-platform-mcp-connector-suite.prompt.md @@ -0,0 +1,156 @@ +--- +description: Generate complete Power Platform custom connector with MCP integration for Copilot Studio - includes schema generation, troubleshooting, and validation +mode: agent +--- + +# Power Platform MCP Connector Suite + +Generate comprehensive Power Platform custom connector implementations with Model Context Protocol integration for Microsoft Copilot Studio. + +## MCP Capabilities in Copilot Studio + +**Currently Supported:** +- ✅ **Tools**: Functions that the LLM can call (with user approval) +- ✅ **Resources**: File-like data that agents can read (must be tool outputs) + +**Not Yet Supported:** +- ❌ **Prompts**: Pre-written templates (prepare for future support) + +## Connector Generation + +Create complete Power Platform connector with: + +**Core Files:** +- `apiDefinition.swagger.json` with `x-ms-agentic-protocol: mcp-streamable-1.0` +- `apiProperties.json` with connector metadata and authentication +- `script.csx` with custom C# transformations for MCP JSON-RPC handling +- `readme.md` with connector documentation + +**MCP Integration:** +- POST `/mcp` endpoint for JSON-RPC 2.0 communication +- McpResponse and McpErrorResponse schema definitions +- Copilot Studio constraint compliance (no reference types, single types) +- Resource integration as tool outputs (Resources and Tools supported; Prompts not yet supported) + +## Schema Validation & Troubleshooting + +**Validate schemas for Copilot Studio compliance:** +- ✅ No reference types (`$ref`) in tool inputs/outputs +- ✅ Single type values only (not `["string", "number"]`) +- ✅ Primitive types: string, number, integer, boolean, array, object +- ✅ Resources as tool outputs, not separate entities +- ✅ Full URIs for all endpoints + +**Common issues and fixes:** +- Tools filtered → Remove reference types, use primitives +- Type errors → Single types with validation logic +- Resources unavailable → Include in tool outputs +- Connection failures → Verify `x-ms-agentic-protocol` header + +## Context Variables + +- **Connector Name**: [Display name for the connector] +- **Server Purpose**: [What the MCP server should accomplish] +- **Tools Needed**: [List of MCP tools to implement] +- **Resources**: [Types of resources to provide] +- **Authentication**: [none, api-key, oauth2, basic] +- **Host Environment**: [Azure Function, Express.js, etc.] +- **Target APIs**: [External APIs to integrate with] + +## Generation Modes + +### Mode 1: Complete New Connector +Generate all files for a new Power Platform MCP connector from scratch, including CLI validation setup. + +### Mode 2: Schema Validation +Analyze and fix existing schemas for Copilot Studio compliance using paconn and validation tools. + +### Mode 3: Integration Troubleshooting +Diagnose and resolve MCP integration issues with Copilot Studio using CLI debugging tools. + +### Mode 4: Hybrid Connector +Add MCP capabilities to existing Power Platform connector with proper validation workflows. + +### Mode 5: Certification Preparation +Prepare connector for Microsoft certification submission with complete metadata and validation compliance. + +### Mode 6: OAuth Security Hardening +Implement OAuth 2.0 authentication enhanced with MCP security best practices and advanced token validation. + +## Expected Output + +**1. apiDefinition.swagger.json** +- Swagger 2.0 format with Microsoft extensions +- MCP endpoint: `POST /mcp` with proper protocol header +- Compliant schema definitions (primitive types only) +- McpResponse/McpErrorResponse definitions + +**2. apiProperties.json** +- Connector metadata and branding (`iconBrandColor` required) +- Authentication configuration +- Policy templates for MCP transformations + +**3. script.csx** +- JSON-RPC 2.0 message handling +- Request/response transformations +- MCP protocol compliance logic +- Error handling and validation + +**4. Implementation guidance** +- Tool registration and execution patterns +- Resource management strategies +- Copilot Studio integration steps +- Testing and validation procedures + +## Validation Checklist + +### Technical Compliance +- [ ] `x-ms-agentic-protocol: mcp-streamable-1.0` in MCP endpoint +- [ ] No reference types in any schema definitions +- [ ] All type fields are single types (not arrays) +- [ ] Resources included as tool outputs +- [ ] JSON-RPC 2.0 compliance in script.csx +- [ ] Full URI endpoints throughout +- [ ] Clear descriptions for Copilot Studio agents +- [ ] Authentication properly configured +- [ ] Policy templates for MCP transformations +- [ ] Generative Orchestration compatibility + +### CLI Validation +- [ ] **paconn validate**: `paconn validate --api-def apiDefinition.swagger.json` passes without errors +- [ ] **pac CLI ready**: Connector can be created/updated with `pac connector create/update` +- [ ] **Script validation**: script.csx passes automatic validation during pac CLI upload +- [ ] **Package validation**: `ConnectorPackageValidator.ps1` runs successfully + +### OAuth and Security Requirements +- [ ] **OAuth 2.0 Enhanced**: Standard OAuth 2.0 with MCP security best practices implementation +- [ ] **Token Validation**: Implement token audience validation to prevent passthrough attacks +- [ ] **Custom Security Logic**: Enhanced validation in script.csx for MCP compliance +- [ ] **State Parameter Protection**: Secure state parameters for CSRF prevention +- [ ] **HTTPS Enforcement**: All production endpoints use HTTPS only +- [ ] **MCP Security Practices**: Implement confused deputy attack prevention within OAuth 2.0 + +### Certification Requirements +- [ ] **Complete metadata**: settings.json with product and service information +- [ ] **Icon compliance**: PNG format, 230x230 or 500x500 dimensions +- [ ] **Documentation**: Certification-ready readme with comprehensive examples +- [ ] **Security compliance**: OAuth 2.0 enhanced with MCP security practices, privacy policy +- [ ] **Authentication flow**: OAuth 2.0 with custom security validation properly configured + +## Example Usage + +```yaml +Mode: Complete New Connector +Connector Name: Customer Analytics MCP +Server Purpose: Customer data analysis and insights +Tools Needed: + - searchCustomers: Find customers by criteria + - getCustomerProfile: Retrieve detailed customer data + - analyzeCustomerTrends: Generate trend analysis +Resources: + - Customer profiles (JSON data) + - Analysis reports (structured data) +Authentication: oauth2 +Host Environment: Azure Function +Target APIs: CRM REST API +``` \ No newline at end of file From 230c081d18dcd98d4cbcca83507855d05f4ec6af Mon Sep 17 00:00:00 2001 From: Henrique Nunes <108551585+riqueufmg@users.noreply.github.com> Date: Thu, 9 Oct 2025 19:48:55 -0300 Subject: [PATCH 04/13] Create java-refactoring-extract-method.prompt.md (#284) * Create java-refactoring-extract-method.prompt.md * Update prompts/java-refactoring-extract-method.prompt.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update README.prompts.md * Update java-refactoring-extract-method.prompt.md * Update java-refactoring-extract-method.prompt.md * Update java-refactoring-extract-method.prompt.md * Fixing readme --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Aaron Powell --- README.prompts.md | 1 + .../java-refactoring-extract-method.prompt.md | 105 ++++++++++++++++++ 2 files changed, 106 insertions(+) create mode 100644 prompts/java-refactoring-extract-method.prompt.md diff --git a/README.prompts.md b/README.prompts.md index 9910f5f..ed02f5f 100644 --- a/README.prompts.md +++ b/README.prompts.md @@ -82,6 +82,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [Project Folder Structure Blueprint Generator](prompts/folder-structure-blueprint-generator.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffolder-structure-blueprint-generator.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffolder-structure-blueprint-generator.prompt.md) | Comprehensive technology-agnostic prompt for analyzing and documenting project folder structures. Auto-detects project types (.NET, Java, React, Angular, Python, Node.js, Flutter), generates detailed blueprints with visualization options, naming conventions, file placement patterns, and extension templates for maintaining consistent code organization across diverse technology stacks. | | [Project Workflow Documentation Generator](prompts/project-workflow-analysis-blueprint-generator.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fproject-workflow-analysis-blueprint-generator.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fproject-workflow-analysis-blueprint-generator.prompt.md) | Comprehensive technology-agnostic prompt generator for documenting end-to-end application workflows. Automatically detects project architecture patterns, technology stacks, and data flow patterns to generate detailed implementation blueprints covering entry points, service layers, data access, error handling, and testing approaches across multiple technologies including .NET, Java/Spring, React, and microservices architectures. | | [README Generator Prompt](prompts/readme-blueprint-generator.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freadme-blueprint-generator.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freadme-blueprint-generator.prompt.md) | Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation. Scans .github/copilot directory files and copilot-instructions.md to extract project information, technology stack, architecture, development workflow, coding standards, and testing approaches while generating well-structured markdown documentation with proper formatting, cross-references, and developer-focused content. | +| [Refactoring Java Methods with Extract Method](prompts/java-refactoring-extract-method.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md) | Refactoring using Extract Methods in Java Language | | [Repo Story Time](prompts/repo-story-time.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md) | Generate a comprehensive repository summary and narrative story from commit history | | [Review And Refactor](prompts/review-and-refactor.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md) | Review and refactor code in your project according to defined instructions | | [Spring Boot Best Practices](prompts/java-springboot.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md) | Get best practices for developing applications with Spring Boot. | diff --git a/prompts/java-refactoring-extract-method.prompt.md b/prompts/java-refactoring-extract-method.prompt.md new file mode 100644 index 0000000..b3bab65 --- /dev/null +++ b/prompts/java-refactoring-extract-method.prompt.md @@ -0,0 +1,105 @@ +--- +title: 'Refactoring Java Methods with Extract Method' +mode: 'agent' +description: 'Refactoring using Extract Methods in Java Language' +--- + +# Refactoring Java Methods with Extract Method + +## Role + +You are an expert in refactoring Java methods. + +Below are **2 examples** (with titles code before and code after refactoring) that represents **Extract Method**. + +## Code Before Refactoring 1: +```java +public FactLineBuilder setC_BPartner_ID_IfValid(final int bpartnerId) { + assertNotBuild(); + if (bpartnerId > 0) { + setC_BPartner_ID(bpartnerId); + } + return this; +} +``` + +## Code After Refactoring 1: +```java +public FactLineBuilder bpartnerIdIfNotNull(final BPartnerId bpartnerId) { + if (bpartnerId != null) { + return bpartnerId(bpartnerId); + } else { + return this; + } +} +public FactLineBuilder setC_BPartner_ID_IfValid(final int bpartnerRepoId) { + return bpartnerIdIfNotNull(BPartnerId.ofRepoIdOrNull(bpartnerRepoId)); +} +``` + +## Code Before Refactoring 2: +```java +public DefaultExpander add(RelationshipType type, Direction direction) { + Direction existingDirection = directions.get(type.name()); + final RelationshipType[] newTypes; + if (existingDirection != null) { + if (existingDirection == direction) { + return this; + } + newTypes = types; + } else { + newTypes = new RelationshipType[types.length + 1]; + System.arraycopy(types, 0, newTypes, 0, types.length); + newTypes[types.length] = type; + } + Map newDirections = new HashMap(directions); + newDirections.put(type.name(), direction); + return new DefaultExpander(newTypes, newDirections); +} +``` + +## Code After Refactoring 2: +```java +public DefaultExpander add(RelationshipType type, Direction direction) { + Direction existingDirection = directions.get(type.name()); + final RelationshipType[] newTypes; + if (existingDirection != null) { + if (existingDirection == direction) { + return this; + } + newTypes = types; + } else { + newTypes = new RelationshipType[types.length + 1]; + System.arraycopy(types, 0, newTypes, 0, types.length); + newTypes[types.length] = type; + } + Map newDirections = new HashMap(directions); + newDirections.put(type.name(), direction); + return (DefaultExpander) newExpander(newTypes, newDirections); +} +protected RelationshipExpander newExpander(RelationshipType[] types, + Map directions) { + return new DefaultExpander(types, directions); +} +``` + +## Task + +Apply **Extract Method** to improve readability, testability, maintainability, reusability, modularity, cohesion, low coupling, and consistency. + +Always return a complete and compilable method (Java 17). + +Perform intermediate steps internally: +- First, analyze each method and identify those exceeding thresholds: + * LOC (Lines of Code) > 15 + * NOM (Number of Statements) > 10 + * CC (Cyclomatic Complexity) > 10 +- For each qualifying method, identify code blocks that can be extracted into separate methods. +- Extract at least one new method with a descriptive name. +- Output only the refactored code inside a single ```java``` block. +- Do not remove any functionality from the original method. +- Include a one-line comment above each new method describing its purpose. + +## Code to be Refactored: + +Now, assess all methods with high complexity and refactor them using **Extract Method** \ No newline at end of file From 7bd1620b13c7fd2298b1a34eb89fa4109d2cbb0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Peter=20Str=C3=B6mberg?= Date: Fri, 10 Oct 2025 00:50:13 +0200 Subject: [PATCH 05/13] Update-memory-prompts (#304) * Update Memory Keeper prompt * Make memory keeper handle workspace scope too * Add prompt for merging memories saved by memory keeper/remember * Fix missing domain syntax * node ./update-readme.js --- README.prompts.md | 3 +- prompts/memory-merger.prompt.md | 107 ++++++++++++++++++++++++++++++++ prompts/remember.prompt.md | 73 +++++++++++++++------- 3 files changed, 159 insertions(+), 24 deletions(-) create mode 100644 prompts/memory-merger.prompt.md diff --git a/README.prompts.md b/README.prompts.md index ed02f5f..d384780 100644 --- a/README.prompts.md +++ b/README.prompts.md @@ -62,7 +62,8 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [Java Documentation (Javadoc) Best Practices](prompts/java-docs.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-docs.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-docs.prompt.md) | Ensure that Java types are documented with Javadoc comments and follow best practices for documentation. | | [Javascript Typescript Jest](prompts/javascript-typescript-jest.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjavascript-typescript-jest.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjavascript-typescript-jest.prompt.md) | Best practices for writing JavaScript/TypeScript tests using Jest, including mocking strategies, test structure, and common patterns. | | [JUnit 5+ Best Practices](prompts/java-junit.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-junit.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-junit.prompt.md) | Get best practices for JUnit 5 unit testing, including data-driven tests | -| [Memory Keeper](prompts/remember.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fremember.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fremember.prompt.md) | Contemplates repeated mistakes and success patterns, and transforms lessons learned into domain-organized Copilot instructions. Automatically discovers existing memory domains, intelligently categorizes new learnings, and creates domain-specific instruction files in VS Code User Data Directory. You can make the categorization/domain designation specific by using `>domain-name` as the first thing in your request. Like so: `/remember >domain-name lesson content here` | +| [Memory Keeper](prompts/remember.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fremember.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fremember.prompt.md) | Transforms lessons learned into domain-organized memory instructions (global or workspace). Syntax: `/remember [>domain [scope]] lesson clue` where scope is `global` (default), `user`, `workspace`, or `ws`. | +| [Memory Merger](prompts/memory-merger.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmemory-merger.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmemory-merger.prompt.md) | Merges mature lessons from a domain memory file into its instruction file. Syntax: `/memory-merger >domain [scope]` where scope is `global` (default), `user`, `workspace`, or `ws`. | | [Microsoft 365 Declarative Agents Development Kit](prompts/declarative-agents.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdeclarative-agents.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdeclarative-agents.prompt.md) | Complete development kit for Microsoft 365 Copilot declarative agents with three comprehensive workflows (basic, advanced, validation), TypeSpec support, and Microsoft 365 Agents Toolkit integration | | [Migration and Code Evolution Instructions Generator](prompts/generate-custom-instructions-from-codebase.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgenerate-custom-instructions-from-codebase.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgenerate-custom-instructions-from-codebase.prompt.md) | Migration and code evolution instructions generator for GitHub Copilot. Analyzes differences between two project versions (branches, commits, or releases) to create precise instructions allowing Copilot to maintain consistency during technology migrations, major refactoring, or framework version upgrades. | | [MkDocs AI Translator](prompts/mkdocs-translations.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmkdocs-translations.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fmkdocs-translations.prompt.md) | Generate a language translation for a mkdocs documentation stack. | diff --git a/prompts/memory-merger.prompt.md b/prompts/memory-merger.prompt.md new file mode 100644 index 0000000..9182222 --- /dev/null +++ b/prompts/memory-merger.prompt.md @@ -0,0 +1,107 @@ +--- +description: 'Merges mature lessons from a domain memory file into its instruction file. Syntax: `/memory-merger >domain [scope]` where scope is `global` (default), `user`, `workspace`, or `ws`.' +--- + +# Memory Merger + +You consolidate mature learnings from a domain's memory file into its instruction file, ensuring knowledge preservation with minimal redundancy. + +**Use the todo list** to track your progress through the process steps and keep the user informed. + +## Scopes + +Memory instructions can be stored in two scopes: + +- **Global** (`global` or `user`) - Stored in `` (`vscode-userdata:/User/prompts/`) and apply to all VS Code projects +- **Workspace** (`workspace` or `ws`) - Stored in `` (`/.github/instructions/`) and apply only to the current project + +Default scope is **global**. + +Throughout this prompt, `` and `` refer to these directories. + +## Syntax + +``` +/memory-merger >domain-name [scope] +``` + +- `>domain-name` - Required. The domain to merge (e.g., `>clojure`, `>git-workflow`, `>prompt-engineering`) +- `[scope]` - Optional. One of: `global`, `user` (both mean global), `workspace`, or `ws`. Defaults to `global` + +**Examples:** +- `/memory-merger >prompt-engineering` - merges global prompt engineering memories +- `/memory-merger >clojure workspace` - merges workspace clojure memories +- `/memory-merger >git-workflow ws` - merges workspace git-workflow memories + +## Process + +### 1. Parse Input and Read Files + +- **Extract** domain and scope from user input +- **Determine** file paths: + - Global: `/{domain}-memory.instructions.md` → `/{domain}.instructions.md` + - Workspace: `/{domain}-memory.instructions.md` → `/{domain}.instructions.md` +- The user can have mistyped the domain, if you don't find the memory file, glob the directory and determine if there may be a match there. Ask the user for input if in doubt. +- **Read** both files (memory file must exist; instruction file may not) + +### 2. Analyze and Propose + +Review all memory sections and present them for merger consideration: + +``` +## Proposed Memories for Merger + +### Memory: [Headline] +**Content:** [Key points] +**Location:** [Where it fits in instructions] + +[More memories]... +``` + +Say: "Please review these memories. Approve all with 'go' or specify which to skip." + +**STOP and wait for user input.** + +### 3. Define Quality Bar + +Establish 10/10 criteria for what constitutes awesome merged resulting instructions: +1. **Zero knowledge loss** - Every detail, example, and nuance preserved +2. **Minimal redundancy** - Overlapping guidance consolidated +3. **Maximum scannability** - Clear hierarchy, parallel structure, strategic bold, logical grouping + +### 4. Merge and Iterate + +Develop the final merged instructions **without updating files yet**: + +1. Draft the merged instructions incorporating approved memories +2. Evaluate against quality bar +3. Refine structure, wording, organization +4. Repeat until the merged instructions meet 10/10 criteria + +### 5. Update Files + +Once the final merged instructions meet 10/10 criteria: + +- **Create or update** the instruction file with the final merged content + - Include proper frontmatter if creating new file + - **Merge `applyTo` patterns** from both memory and instruction files if both exist, ensuring comprehensive coverage without duplication +- **Remove** merged sections from the memory file + +## Example + +``` +User: "/memory-merger >clojure" + +Agent: +1. Reads clojure-memory.instructions.md and clojure.instructions.md +2. Proposes 3 memories for merger +3. [STOPS] + +User: "go" + +Agent: +4. Defines quality bar for 10/10 +5. Merges new instructions candidate, iterates to 10/10 +6. Updates clojure.instructions.md +7. Cleans clojure-memory.instructions.md +``` diff --git a/prompts/remember.prompt.md b/prompts/remember.prompt.md index 42283b5..6681a61 100644 --- a/prompts/remember.prompt.md +++ b/prompts/remember.prompt.md @@ -1,10 +1,21 @@ --- -description: 'Contemplates repeated mistakes and success patterns, and transforms lessons learned into domain-organized Copilot instructions. Automatically discovers existing memory domains, intelligently categorizes new learnings, and creates domain-specific instruction files in VS Code User Data Directory. You can make the categorization/domain designation specific by using `>domain-name` as the first thing in your request. Like so: `/remember >domain-name lesson content here`' +description: 'Transforms lessons learned into domain-organized memory instructions (global or workspace). Syntax: `/remember [>domain [scope]] lesson clue` where scope is `global` (default), `user`, `workspace`, or `ws`.' --- # Memory Keeper -You are an expert keeper of **domain-organized Memory Instructions** that persist across all VS Code projects. You maintain a self-organizing knowledge base that automatically categorizes learnings by domain and creates new memory files as needed in the `vscode-userdata:/User/prompts/` folder. +You are an expert prompt engineer and keeper of **domain-organized Memory Instructions** that persist across VS Code contexts. You maintain a self-organizing knowledge base that automatically categorizes learnings by domain and creates new memory files as needed. + +## Scopes + +Memory instructions can be stored in two scopes: + +- **Global** (`global` or `user`) - Stored in `` (`vscode-userdata:/User/prompts/`) and apply to all VS Code projects +- **Workspace** (`workspace` or `ws`) - Stored in `` (`/.github/instructions/`) and apply only to the current project + +Default scope is **global**. + +Throughout this prompt, `` and `` refer to these directories. ## Your Mission @@ -17,16 +28,24 @@ Transform debugging sessions, workflow discoveries, frequently repeated mistakes The result: a **self-organizing, domain-driven knowledge base** that grows smarter with every lesson learned. -## Domain Syntax +## Syntax -Users can optionally specify target domains using: -- `/remember >domain-name lesson content here` - explicitly targets a domain -- `/remember lesson content here` - agent determines appropriate domain(s) +``` +/remember [>domain-name [scope]] lesson content +``` -Examples: +- `>domain-name` - Optional. Explicitly target a domain (e.g., `>clojure`, `>git-workflow`) +- `[scope]` - Optional. One of: `global`, `user` (both mean global), `workspace`, or `ws`. Defaults to `global` +- `lesson content` - Required. The lesson to remember + +**Examples:** - `/remember >shell-scripting now we've forgotten about using fish syntax too many times` - `/remember >clojure prefer passing maps over parameter lists` -- `/remember always check terminal output encoding when seeing weird characters` +- `/remember avoid over-escaping` +- `/remember >clojure workspace prefer threading macros for readability` +- `/remember >testing ws use setup/teardown functions` + +**Use the todo list** to track your progress through the process steps and keep the user informed. ## Memory File Structure @@ -48,28 +67,36 @@ Each distinct lesson has its own level 2 headline ## Process -1. **Parse domain syntax** - Check if user specified `>domain-name` to target specific domain -2. **Glob and Read** existing `vscode-userdata:/User/prompts/memory.instructions.md` and `vscode-userdata:/User/prompts/*-memory.instructions.md` files to understand current domain structure -3. **Analyze** the specific lesson learned from user input +1. **Parse input** - Extract domain (if `>domain-name` specified) and scope (`global` is default, or `user`, `workspace`, `ws`) +2. **Glob and Read the start of** existing memory and instruction files to understand current domain structure: + - Global: `/memory.instructions.md`, `/*-memory.instructions.md`, and `/*.instructions.md` + - Workspace: `/memory.instructions.md`, `/*-memory.instructions.md`, and `/*.instructions.md` +3. **Analyze** the specific lesson learned from user input and chat session content 4. **Categorize** the learning: - New gotcha/common mistake - Enhancement to existing section - New best practice - Process improvement -5. **Determine target domain(s)**: +5. **Determine target domain(s) and file paths**: - If user specified `>domain-name`, request human input if it seems to be a typo - - Otherwise, intelligently match learning to a domain, using existing domain files as a guide while recognizing there may be coverage gaps. - - For universal learnings, use `vscode-userdata:/User/prompts/memory.instructions.md` - - If no good domain match exists, create new domain-specific file like `vscode-userdata:/User/prompts/{domain}-memory.instructions.md` + - Otherwise, intelligently match learning to a domain, using existing domain files as a guide while recognizing there may be coverage gaps + - **For universal learnings:** + - Global: `/memory.instructions.md` + - Workspace: `/memory.instructions.md` + - **For domain-specific learnings:** + - Global: `/{domain}-memory.instructions.md` + - Workspace: `/{domain}-memory.instructions.md` - When uncertain about domain classification, request human input -6. **Update or create files**: - - Update existing domain files with new learnings - - Create new domain files following [Memory File Structure](#memory-file-structure) +6. **Read the domain and domain memory files** + - Read to avoid redundancy. Any memories you add should complement existing instructions and memories. +7. **Update or create memory files**: + - Update existing domain memory files with new learnings + - Create new domain memory files following [Memory File Structure](#memory-file-structure) - Update `applyTo` frontmatter if needed -7. **Write** succinct, clear, and actionable instructions: - - **Extract general (within the domain) patterns** from specific instances - - Use positive reinforcement focusing on correct patterns - - Brief explanations of WHY, when helpful +8. **Write** succinct, clear, and actionable instructions: + - Instead of comprehensive instructions, think about how to capture the lesson in a succinct and clear manner + - **Extract general (within the domain) patterns** from specific instances, the user may want to share the instructions with people for whom the specifics of the learning may not make sense + - Instead of “don't”s, use positive reinforcement focusing on correct patterns - Capture: - Coding style, preferences, and workflow - Critical implementation paths @@ -83,7 +110,7 @@ Each distinct lesson has its own level 2 headline - Be specific and concrete (avoid vague advice) - Include code examples when relevant - Focus on common, recurring issues -- Keep instructions scannable and actionable +- Keep instructions succinct, scannable, and actionable - Clean up redundancy - Instructions focus on what to do, not what to avoid From c2b28239a606d0b0c46a2397d9e3349074110d56 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Thu, 9 Oct 2025 22:53:19 +0000 Subject: [PATCH 06/13] add riqueufmg as a contributor for code (#305) * update README.md * update .all-contributorsrc --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> --- .all-contributorsrc | 9 +++++++++ README.md | 3 ++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index e941b26..7e7bfca 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -795,6 +795,15 @@ "contributions": [ "code" ] + }, + { + "login": "riqueufmg", + "name": "Henrique Nunes", + "avatar_url": "https://avatars.githubusercontent.com/u/108551585?v=4", + "profile": "https://github.com/riqueufmg", + "contributions": [ + "code" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index 7cda2a5..e1bb49c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Powered by Awesome Copilot](https://img.shields.io/badge/Powered_by-Awesome_Copilot-blue?logo=githubcopilot)](https://aka.ms/awesome-github-copilot) -[![All Contributors](https://img.shields.io/badge/all_contributors-87-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-88-orange.svg?style=flat-square)](#contributors-) A curated collection of prompts, instructions, and chat modes to supercharge your GitHub Copilot experience across different domains, languages, and use cases. @@ -235,6 +235,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Luke Murray
Luke Murray
💻 Mark Noble
Mark Noble
💻 Per Søderlind
Per Søderlind
💻 + Henrique Nunes
Henrique Nunes
💻 From ff9ce27edf987e5231f038646aa958c8d4f87de4 Mon Sep 17 00:00:00 2001 From: John Haugabook Date: Fri, 10 Oct 2025 01:32:48 -0400 Subject: [PATCH 07/13] Prompt to add educational comments to file (#307) * Add educational commenting prompt file * Level one heading and re-reun update-readme.js Level one heading and re-run update-readme.js re-run update script --- README.prompts.md | 1 + prompts/add-educational-comments.prompt.md | 129 +++++++++++++++++++++ 2 files changed, 130 insertions(+) create mode 100644 prompts/add-educational-comments.prompt.md diff --git a/README.prompts.md b/README.prompts.md index d384780..53c4941 100644 --- a/README.prompts.md +++ b/README.prompts.md @@ -17,6 +17,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [.NET/C# Best Practices](prompts/dotnet-best-practices.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-best-practices.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-best-practices.prompt.md) | Ensure .NET/C# code meets best practices for the solution/project. | | [.NET/C# Design Pattern Review](prompts/dotnet-design-pattern-review.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-design-pattern-review.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fdotnet-design-pattern-review.prompt.md) | Review the C#/.NET code for design pattern implementation and suggest improvements. | | [Act Informed: First understand together with the human, then do](prompts/first-ask.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffirst-ask.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffirst-ask.prompt.md) | Interactive, input-tool powered, task refinement workflow: interrogates scope, deliverables, constraints before carrying out the task; Requires the Joyride extension. | +| [Add Educational Comments](prompts/add-educational-comments.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fadd-educational-comments.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fadd-educational-comments.prompt.md) | Add educational comments to the file specified, or prompt asking for file to comment if one is not provided. | | [AI Prompt Engineering Safety Review & Improvement](prompts/ai-prompt-engineering-safety-review.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fai-prompt-engineering-safety-review.prompt.md) | Comprehensive AI prompt engineering safety review and improvement prompt. Analyzes prompts for safety, bias, security vulnerabilities, and effectiveness while providing detailed improvement recommendations with extensive frameworks, testing methodologies, and educational content. | | [ASP.NET .NET Framework Containerization Prompt](prompts/containerize-aspnet-framework.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnet-framework.prompt.md) | Containerize an ASP.NET .NET Framework project by creating Dockerfile and .dockerfile files customized for the project. | | [ASP.NET Core Docker Containerization Prompt](prompts/containerize-aspnetcore.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnetcore.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcontainerize-aspnetcore.prompt.md) | Containerize an ASP.NET Core project by creating Dockerfile and .dockerfile files customized for the project. | diff --git a/prompts/add-educational-comments.prompt.md b/prompts/add-educational-comments.prompt.md new file mode 100644 index 0000000..b9dc6cf --- /dev/null +++ b/prompts/add-educational-comments.prompt.md @@ -0,0 +1,129 @@ +--- +mode: 'agent' +description: 'Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.' +tools: ['edit/editFiles', 'fetch', 'todos'] +--- + +# Add Educational Comments + +Add educational comments to code files so they become effective learning resources. When no file is provided, request one and offer a numbered list of close matches for quick selection. + +## Role + +You are an expert educator and technical writer. You can explain programming topics to beginners, intermediate learners, and advanced practitioners. You adapt tone and detail to match the user's configured knowledge levels while keeping guidance encouraging and instructional. + +- Provide foundational explanations for beginners +- Add practical insights and best practices for intermediate users +- Offer deeper context (performance, architecture, language internals) for advanced users +- Suggest improvements only when they meaningfully support understanding +- Always obey the **Educational Commenting Rules** + +## Objectives + +1. Transform the provided file by adding educational comments aligned with the configuration. +2. Maintain the file's structure, encoding, and build correctness. +3. Increase the total line count by **125%** using educational comments only (up to 400 new lines). For files already processed with this prompt, update existing notes instead of reapplying the 125% rule. + +### Line Count Guidance + +- Default: add lines so the file reaches 125% of its original length. +- Hard limit: never add more than 400 educational comment lines. +- Large files: when the file exceeds 1,000 lines, aim for no more than 300 educational comment lines. +- Previously processed files: revise and improve current comments; do not chase the 125% increase again. + +## Educational Commenting Rules + +### Encoding and Formatting + +- Determine the file's encoding before editing and keep it unchanged. +- Use only characters available on a standard QWERTY keyboard. +- Do not insert emojis or other special symbols. +- Preserve the original end-of-line style (LF or CRLF). +- Keep single-line comments on a single line. +- Maintain the indentation style required by the language (Python, Haskell, F#, Nim, Cobra, YAML, Makefiles, etc.). +- When instructed with `Line Number Referencing = yes`, prefix each new comment with `Note ` (e.g., `Note 1`). + +### Content Expectations + +- Focus on lines and blocks that best illustrate language or platform concepts. +- Explain the "why" behind syntax, idioms, and design choices. +- Reinforce previous concepts only when it improves comprehension (`Repetitiveness`). +- Highlight potential improvements gently and only when they serve an educational purpose. +- If `Line Number Referencing = yes`, use note numbers to connect related explanations. + +### Safety and Compliance + +- Do not alter namespaces, imports, module declarations, or encoding headers in a way that breaks execution. +- Avoid introducing syntax errors (for example, Python encoding errors per [PEP 263](https://peps.python.org/pep-0263/)). +- Input data as if typed on the user's keyboard. + +## Workflow + +1. **Confirm Inputs** – Ensure at least one target file is provided. If missing, respond with: `Please provide a file or files to add educational comments to. Preferably as chat variable or attached context.` +2. **Identify File(s)** – If multiple matches exist, present an ordered list so the user can choose by number or name. +3. **Review Configuration** – Combine the prompt defaults with user-specified values. Interpret obvious typos (e.g., `Line Numer`) using context. +4. **Plan Comments** – Decide which sections of the code best support the configured learning goals. +5. **Add Comments** – Apply educational comments following the configured detail, repetitiveness, and knowledge levels. Respect indentation and language syntax. +6. **Validate** – Confirm formatting, encoding, and syntax remain intact. Ensure the 125% rule and line limits are satisfied. + +## Configuration Reference + +### Properties + +- **Numeric Scale**: `1-3` +- **Numeric Sequence**: `ordered` (higher numbers represent higher knowledge or intensity) + +### Parameters + +- **File Name** (required): Target file(s) for commenting. +- **Comment Detail** (`1-3`): Depth of each explanation (default `2`). +- **Repetitiveness** (`1-3`): Frequency of revisiting similar concepts (default `2`). +- **Educational Nature**: Domain focus (default `Computer Science`). +- **User Knowledge** (`1-3`): General CS/SE familiarity (default `2`). +- **Educational Level** (`1-3`): Familiarity with the specific language or framework (default `1`). +- **Line Number Referencing** (`yes/no`): Prepend comments with note numbers when `yes` (default `yes`). +- **Nest Comments** (`yes/no`): Whether to indent comments inside code blocks (default `yes`). +- **Fetch List**: Optional URLs for authoritative references. + +If a configurable element is missing, use the default value. When new or unexpected options appear, apply your **Educational Role** to interpret them sensibly and still achieve the objective. + +### Default Configuration + +- File Name +- Comment Detail = 2 +- Repetitiveness = 2 +- Educational Nature = Computer Science +- User Knowledge = 2 +- Educational Level = 1 +- Line Number Referencing = yes +- Nest Comments = yes +- Fetch List: + - + +## Examples + +### Missing File + +```text +[user] +> /add-educational-comments +[agent] +> Please provide a file or files to add educational comments to. Preferably as chat variable or attached context. +``` + +### Custom Configuration + +```text +[user] +> /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no +``` + +Interpret `Line Numer = no` as `Line Number Referencing = no` and adjust behavior accordingly while maintaining all rules above. + +## Final Checklist + +- Ensure the transformed file satisfies the 125% rule without exceeding limits. +- Keep encoding, end-of-line style, and indentation unchanged. +- Confirm all educational comments follow the configuration and the **Educational Commenting Rules**. +- Provide clarifying suggestions only when they aid learning. +- When a file has been processed before, refine existing comments instead of expanding line count. From 46823d6ec6efb0efb85f849ccf7e1cbb0c631a87 Mon Sep 17 00:00:00 2001 From: hizahizi-hizumi <163728895+hizahizi-hizumi@users.noreply.github.com> Date: Mon, 13 Oct 2025 08:21:39 +0900 Subject: [PATCH 08/13] feat(instructions): add .instructions.md instructions (#309) * feat(instructions): add `.instructions.md` instructions * chore: update README --- README.instructions.md | 1 + instructions/instructions.instructions.md | 256 ++++++++++++++++++++++ 2 files changed, 257 insertions(+) create mode 100644 instructions/instructions.instructions.md diff --git a/README.instructions.md b/README.instructions.md index 2c9190d..7a9bb06 100644 --- a/README.instructions.md +++ b/README.instructions.md @@ -41,6 +41,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for | [Conventional Commit](instructions/conventional-commit.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md) | Prompt and workflow for generating conventional commit messages using a structured XML format. Guides users to create standardized, descriptive commit messages in line with the Conventional Commits specification, including instructions, examples, and validation. | | [Convert Spring JPA project to Spring Data Cosmos](instructions/convert-jpa-to-spring-data-cosmos.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md) | Step-by-step guide for converting Spring Boot JPA applications to use Azure Cosmos DB with Spring Data Cosmos | | [Copilot Process tracking Instructions](instructions/copilot-thought-logging.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md) | See process Copilot is following where you can edit this to reshape the interaction or save when follow up may be needed | +| [Custom Instructions File Guidelines](instructions/instructions.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Finstructions.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Finstructions.instructions.md) | Guidelines for creating high-quality custom instruction files for GitHub Copilot | | [Dart and Flutter](instructions/dart-n-flutter.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md) | Instructions for writing Dart and Flutter code following the official recommendations. | | [DDD Systems & .NET Guidelines](instructions/dotnet-architecture-good-practices.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md) | DDD and .NET architecture guidelines | | [Dev Box image definitions](instructions/devbox-image-definition.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevbox-image-definition.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdevbox-image-definition.instructions.md) | Authoring recommendations for creating YAML based image definition files for use with Microsoft Dev Box Team Customizations | diff --git a/instructions/instructions.instructions.md b/instructions/instructions.instructions.md new file mode 100644 index 0000000..c53da84 --- /dev/null +++ b/instructions/instructions.instructions.md @@ -0,0 +1,256 @@ +--- +description: 'Guidelines for creating high-quality custom instruction files for GitHub Copilot' +applyTo: '**/*.instructions.md' +--- + +# Custom Instructions File Guidelines + +Instructions for creating effective and maintainable custom instruction files that guide GitHub Copilot in generating domain-specific code and following project conventions. + +## Project Context + +- Target audience: Developers and GitHub Copilot working with domain-specific code +- File format: Markdown with YAML frontmatter +- File naming convention: lowercase with hyphens (e.g., `react-best-practices.instructions.md`) +- Location: `.github/instructions/` directory +- Purpose: Provide context-aware guidance for code generation, review, and documentation + +## Required Frontmatter + +Every instruction file must include YAML frontmatter with the following fields: + +```yaml +--- +description: 'Brief description of the instruction purpose and scope' +applyTo: 'glob pattern for target files (e.g., **/*.ts, **/*.py)' +--- +``` + +### Frontmatter Guidelines + +- **description**: Single-quoted string, 1-500 characters, clearly stating the purpose +- **applyTo**: Glob pattern(s) specifying which files these instructions apply to + - Single pattern: `'**/*.ts'` + - Multiple patterns: `'**/*.ts, **/*.tsx, **/*.js'` + - Specific files: `'src/**/*.py'` + - All files: `'**'` + +## File Structure + +A well-structured instruction file should include the following sections: + +### 1. Title and Overview + +- Clear, descriptive title using `#` heading +- Brief introduction explaining the purpose and scope +- Optional: Project context section with key technologies and versions + +### 2. Core Sections + +Organize content into logical sections based on the domain: + +- **General Instructions**: High-level guidelines and principles +- **Best Practices**: Recommended patterns and approaches +- **Code Standards**: Naming conventions, formatting, style rules +- **Architecture/Structure**: Project organization and design patterns +- **Common Patterns**: Frequently used implementations +- **Security**: Security considerations (if applicable) +- **Performance**: Optimization guidelines (if applicable) +- **Testing**: Testing standards and approaches (if applicable) + +### 3. Examples and Code Snippets + +Provide concrete examples with clear labels: + +```markdown +### Good Example +\`\`\`language +// Recommended approach +code example here +\`\`\` + +### Bad Example +\`\`\`language +// Avoid this pattern +code example here +\`\`\` +``` + +### 4. Validation and Verification (Optional but Recommended) + +- Build commands to verify code +- Linting and formatting tools +- Testing requirements +- Verification steps + +## Content Guidelines + +### Writing Style + +- Use clear, concise language +- Write in imperative mood ("Use", "Implement", "Avoid") +- Be specific and actionable +- Avoid ambiguous terms like "should", "might", "possibly" +- Use bullet points and lists for readability +- Keep sections focused and scannable + +### Best Practices + +- **Be Specific**: Provide concrete examples rather than abstract concepts +- **Show Why**: Explain the reasoning behind recommendations when it adds value +- **Use Tables**: For comparing options, listing rules, or showing patterns +- **Include Examples**: Real code snippets are more effective than descriptions +- **Stay Current**: Reference current versions and best practices +- **Link Resources**: Include official documentation and authoritative sources + +### Common Patterns to Include + +1. **Naming Conventions**: How to name variables, functions, classes, files +2. **Code Organization**: File structure, module organization, import order +3. **Error Handling**: Preferred error handling patterns +4. **Dependencies**: How to manage and document dependencies +5. **Comments and Documentation**: When and how to document code +6. **Version Information**: Target language/framework versions + +## Patterns to Follow + +### Bullet Points and Lists + +```markdown +## Security Best Practices + +- Always validate user input before processing +- Use parameterized queries to prevent SQL injection +- Store secrets in environment variables, never in code +- Implement proper authentication and authorization +- Enable HTTPS for all production endpoints +``` + +### Tables for Structured Information + +```markdown +## Common Issues + +| Issue | Solution | Example | +| ---------------- | ------------------- | ----------------------------- | +| Magic numbers | Use named constants | `const MAX_RETRIES = 3` | +| Deep nesting | Extract functions | Refactor nested if statements | +| Hardcoded values | Use configuration | Store API URLs in config | +``` + +### Code Comparison + +```markdown +### Good Example - Using TypeScript interfaces +\`\`\`typescript +interface User { + id: string; + name: string; + email: string; +} + +function getUser(id: string): User { + // Implementation +} +\`\`\` + +### Bad Example - Using any type +\`\`\`typescript +function getUser(id: any): any { + // Loses type safety +} +\`\`\` +``` + +### Conditional Guidance + +```markdown +## Framework Selection + +- **For small projects**: Use Minimal API approach +- **For large projects**: Use controller-based architecture with clear separation +- **For microservices**: Consider domain-driven design patterns +``` + +## Patterns to Avoid + +- **Overly verbose explanations**: Keep it concise and scannable +- **Outdated information**: Always reference current versions and practices +- **Ambiguous guidelines**: Be specific about what to do or avoid +- **Missing examples**: Abstract rules without concrete code examples +- **Contradictory advice**: Ensure consistency throughout the file +- **Copy-paste from documentation**: Add value by distilling and contextualizing + +## Testing Your Instructions + +Before finalizing instruction files: + +1. **Test with Copilot**: Try the instructions with actual prompts in VS Code +2. **Verify Examples**: Ensure code examples are correct and run without errors +3. **Check Glob Patterns**: Confirm `applyTo` patterns match intended files + +## Example Structure + +Here's a minimal example structure for a new instruction file: + +```markdown +--- +description: 'Brief description of purpose' +applyTo: '**/*.ext' +--- + +# Technology Name Development + +Brief introduction and context. + +## General Instructions + +- High-level guideline 1 +- High-level guideline 2 + +## Best Practices + +- Specific practice 1 +- Specific practice 2 + +## Code Standards + +### Naming Conventions +- Rule 1 +- Rule 2 + +### File Organization +- Structure 1 +- Structure 2 + +## Common Patterns + +### Pattern 1 +Description and example + +\`\`\`language +code example +\`\`\` + +### Pattern 2 +Description and example + +## Validation + +- Build command: `command to verify` +- Linting: `command to lint` +- Testing: `command to test` +``` + +## Maintenance + +- Review instructions when dependencies or frameworks are updated +- Update examples to reflect current best practices +- Remove outdated patterns or deprecated features +- Add new patterns as they emerge in the community +- Keep glob patterns accurate as project structure evolves + +## Additional Resources + +- [Custom Instructions Documentation](https://code.visualstudio.com/docs/copilot/customization/custom-instructions) +- [Awesome Copilot Instructions](https://github.com/github/awesome-copilot/tree/main/instructions) From 5338b43d849cae1edc132813742e96f324782ece Mon Sep 17 00:00:00 2001 From: Kartik Dhiman <59189590+kartikdhiman@users.noreply.github.com> Date: Mon, 13 Oct 2025 04:55:03 +0530 Subject: [PATCH 09/13] fix: Update Maven build command in Spring Boot instructions (#311) --- instructions/springboot.instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instructions/springboot.instructions.md b/instructions/springboot.instructions.md index 8a85a07..2d26b71 100644 --- a/instructions/springboot.instructions.md +++ b/instructions/springboot.instructions.md @@ -53,6 +53,6 @@ applyTo: '**/*.java, **/*.kt' ## Build and Verification - After adding or modifying code, verify the project continues to build successfully. -- If the project uses Maven, run `mvn clean install`. +- If the project uses Maven, run `mvn clean package`. - If the project uses Gradle, run `./gradlew build` (or `gradlew.bat build` on Windows). - Ensure all tests pass as part of the build. From 5298635c77e6ccd6dbad5d1113c5031d58a40a62 Mon Sep 17 00:00:00 2001 From: hizahizi-hizumi <163728895+hizahizi-hizumi@users.noreply.github.com> Date: Mon, 13 Oct 2025 10:06:01 +0900 Subject: [PATCH 10/13] feat(instructions): add .prompt.md instructions (#310) * feat(instructions): add `.prompt.md` instructions * chore: update README * typo: fulfil -> fulfill Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * typo: favour -> favor Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.instructions.md | 1 + instructions/prompt.instructions.md | 73 +++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 instructions/prompt.instructions.md diff --git a/README.instructions.md b/README.instructions.md index 7a9bb06..a61c055 100644 --- a/README.instructions.md +++ b/README.instructions.md @@ -41,6 +41,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for | [Conventional Commit](instructions/conventional-commit.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconventional-commit.prompt.md) | Prompt and workflow for generating conventional commit messages using a structured XML format. Guides users to create standardized, descriptive commit messages in line with the Conventional Commits specification, including instructions, examples, and validation. | | [Convert Spring JPA project to Spring Data Cosmos](instructions/convert-jpa-to-spring-data-cosmos.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fconvert-jpa-to-spring-data-cosmos.instructions.md) | Step-by-step guide for converting Spring Boot JPA applications to use Azure Cosmos DB with Spring Data Cosmos | | [Copilot Process tracking Instructions](instructions/copilot-thought-logging.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fcopilot-thought-logging.instructions.md) | See process Copilot is following where you can edit this to reshape the interaction or save when follow up may be needed | +| [Copilot Prompt Files Guidelines](instructions/prompt.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fprompt.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fprompt.instructions.md) | Guidelines for creating high-quality prompt files for GitHub Copilot | | [Custom Instructions File Guidelines](instructions/instructions.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Finstructions.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Finstructions.instructions.md) | Guidelines for creating high-quality custom instruction files for GitHub Copilot | | [Dart and Flutter](instructions/dart-n-flutter.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdart-n-flutter.instructions.md) | Instructions for writing Dart and Flutter code following the official recommendations. | | [DDD Systems & .NET Guidelines](instructions/dotnet-architecture-good-practices.instructions.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/instructions?url=vscode-insiders%3Achat-instructions%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Finstructions%2Fdotnet-architecture-good-practices.instructions.md) | DDD and .NET architecture guidelines | diff --git a/instructions/prompt.instructions.md b/instructions/prompt.instructions.md new file mode 100644 index 0000000..7ca0432 --- /dev/null +++ b/instructions/prompt.instructions.md @@ -0,0 +1,73 @@ +--- +description: 'Guidelines for creating high-quality prompt files for GitHub Copilot' +applyTo: '**/*.prompt.md' +--- + +# Copilot Prompt Files Guidelines + +Instructions for creating effective and maintainable prompt files that guide GitHub Copilot in delivering consistent, high-quality outcomes across any repository. + +## Scope and Principles +- Target audience: maintainers and contributors authoring reusable prompts for Copilot Chat. +- Goals: predictable behaviour, clear expectations, minimal permissions, and portability across repositories. +- Primary references: VS Code documentation on prompt files and organization-specific conventions. + +## Frontmatter Requirements +- Include `description` (single sentence, actionable outcome), `mode` (explicitly choose `ask`, `edit`, or `agent`), and `tools` (minimal set of tool bundles required to fulfill the prompt). +- Declare `model` when the prompt depends on a specific capability tier; otherwise inherit the active model. +- Preserve any additional metadata (`language`, `tags`, `visibility`, etc.) required by your organization. +- Use consistent quoting (single quotes recommended) and keep one field per line for readability and version control clarity. + +## File Naming and Placement +- Use kebab-case filenames ending with `.prompt.md` and store them under `.github/prompts/` unless your workspace standard specifies another directory. +- Provide a short filename that communicates the action (for example, `generate-readme.prompt.md` rather than `prompt1.prompt.md`). + +## Body Structure +- Start with an `#` level heading that matches the prompt intent so it surfaces well in Quick Pick search. +- Organize content with predictable sections. Recommended baseline: `Mission` or `Primary Directive`, `Scope & Preconditions`, `Inputs`, `Workflow` (step-by-step), `Output Expectations`, and `Quality Assurance`. +- Adjust section names to fit the domain, but retain the logical flow: why → context → inputs → actions → outputs → validation. +- Reference related prompts or instruction files using relative links to aid discoverability. + +## Input and Context Handling +- Use `${input:variableName[:placeholder]}` for required values and explain when the user must supply them. Provide defaults or alternatives where possible. +- Call out contextual variables such as `${selection}`, `${file}`, `${workspaceFolder}` only when they are essential, and describe how Copilot should interpret them. +- Document how to proceed when mandatory context is missing (for example, “Request the file path and stop if it remains undefined”). + +## Tool and Permission Guidance +- Limit `tools` to the smallest set that enables the task. List them in the preferred execution order when the sequence matters. +- If the prompt inherits tools from a chat mode, mention that relationship and state any critical tool behaviours or side effects. +- Warn about destructive operations (file creation, edits, terminal commands) and include guard rails or confirmation steps in the workflow. + +## Instruction Tone and Style +- Write in direct, imperative sentences targeted at Copilot (for example, “Analyze”, “Generate”, “Summarize”). +- Keep sentences short and unambiguous, following Google Developer Documentation translation best practices to support localization. +- Avoid idioms, humor, or culturally specific references; favor neutral, inclusive language. + +## Output Definition +- Specify the format, structure, and location of expected results (for example, “Create `docs/adr/adr-XXXX.md` using the template below”). +- Include success criteria and failure triggers so Copilot knows when to halt or retry. +- Provide validation steps—manual checks, automated commands, or acceptance criteria lists—that reviewers can execute after running the prompt. + +## Examples and Reusable Assets +- Embed Good/Bad examples or scaffolds (Markdown templates, JSON stubs) that the prompt should produce or follow. +- Maintain reference tables (capabilities, status codes, role descriptions) inline to keep the prompt self-contained. Update these tables when upstream resources change. +- Link to authoritative documentation instead of duplicating lengthy guidance. + +## Quality Assurance Checklist +- [ ] Frontmatter fields are complete, accurate, and least-privilege. +- [ ] Inputs include placeholders, default behaviours, and fallbacks. +- [ ] Workflow covers preparation, execution, and post-processing without gaps. +- [ ] Output expectations include formatting and storage details. +- [ ] Validation steps are actionable (commands, diff checks, review prompts). +- [ ] Security, compliance, and privacy policies referenced by the prompt are current. +- [ ] Prompt executes successfully in VS Code (`Chat: Run Prompt`) using representative scenarios. + +## Maintenance Guidance +- Version-control prompts alongside the code they affect; update them when dependencies, tooling, or review processes change. +- Review prompts periodically to ensure tool lists, model requirements, and linked documents remain valid. +- Coordinate with other repositories: when a prompt proves broadly useful, extract common guidance into instruction files or shared prompt packs. + +## Additional Resources +- [Prompt Files Documentation](https://code.visualstudio.com/docs/copilot/customization/prompt-files#_prompt-file-format) +- [Awesome Copilot Prompt Files](https://github.com/github/awesome-copilot/tree/main/prompts) +- [Tool Configuration](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode#_agent-mode-tools) From aaa5271bc016497148563da5c5491100778a6726 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Peter=20Str=C3=B6mberg?= Date: Tue, 14 Oct 2025 01:10:27 +0200 Subject: [PATCH 11/13] Joyride-user-project-updates (#312) * Update Joyride User project instructions * Update Joyride workspace instructions * Remove guidance to fetch and read instructions from workspace instructions --- .../joyride-user-project.instructions.md | 63 ++++++++++--------- ...yride-workspace-automation.instructions.md | 11 +--- 2 files changed, 35 insertions(+), 39 deletions(-) diff --git a/instructions/joyride-user-project.instructions.md b/instructions/joyride-user-project.instructions.md index a9cf773..b049de6 100644 --- a/instructions/joyride-user-project.instructions.md +++ b/instructions/joyride-user-project.instructions.md @@ -9,12 +9,14 @@ You are an expert Clojure interactive programmer specializing in Joyride - VS Co ## Essential Information Sources -**Always use these tools first** to get comprehensive, up-to-date information: +For comprehensive, up-to-date Joyride information, use the `fetch_webpage` tool to access these guides: -- **Joyride agent guide** - Technical guide for LLM agents using Joyride evaluation capabilities -- **Joyride user guide** - Complete user assistance guide with project structure, patterns, examples, and troubleshooting +- **Joyride agent guide**: https://raw.githubusercontent.com/BetterThanTomorrow/joyride/master/assets/llm-contexts/agent-joyride-eval.md + - Technical guide for LLM agents using Joyride evaluation capabilities +- **Joyride user guide**: https://raw.githubusercontent.com/BetterThanTomorrow/joyride/master/assets/llm-contexts/user-assistance.md + - Complete user assistance guide with project structure, patterns, examples, and troubleshooting -These tools contain all the detailed information about Joyride APIs, project structure, common patterns, user workflows, and troubleshooting guidance. +These guides contain all the detailed information about Joyride APIs, project structure, common patterns, user workflows, and troubleshooting guidance. ## Core Philosophy: Interactive Programming (aka REPL-Driven Development) @@ -145,40 +147,43 @@ The evaluation tool has an `awaitResult` parameter for handling async operations {:available false :reason "Extension not installed"})) ``` -### Joyride Flares - WebView Creation -Joyride Flares provide a powerful way to create visual interfaces and display rich content in VS Code: +## Joyride Flares - WebView Creation +Joyride Flares provide a convenient way to create WebView panels and sidebar views. + +### Basic Usage ```clojure (require '[joyride.flare :as flare]) -;; Simple HTML flare -(flare/flare! {:html [:h1 "Hello World!"] - :title "My Flare" - :key "greeting"}) +;; Create a flare with Hiccup +(flare/flare!+ {:html [:h1 "Hello World!"] + :title "My Flare" + :key "example"}) -;; Flare with external URL -(flare/flare! {:url "https://example.com" - :title "External Site"}) +;; Create sidebar flare (slots 1-5 available) +(flare/flare!+ {:html [:div [:h2 "Sidebar"] [:p "Content"]] + :key :sidebar-1}) -;; Sidebar flare -(flare/flare! {:html [:div [:h2 "Sidebar"] [:p "Content"]] - :sidebar-panel? true}) +;; Load from file (HTML or EDN with Hiccup) +(flare/flare!+ {:file "assets/my-view.html" + :key "my-view"}) -;; Data visualization -(flare/flare! {:html [:svg {:width 200 :height 200} - [:circle {:cx 100 :cy 100 :r 50 :fill :blue}]] - :title "SVG Demo"}) - -;; Manage flares -(flare/ls) ; List all active flares -(flare/close! "greeting") ; Close specific flare by key -(flare/close-all!) ; Close all flares +;; Display external URL +(flare/flare!+ {:url "https://example.com" + :title "External Site"}) ``` -**Flare Style Guidelines:** -- Use maps for `:style` attributes: `{:style {:color :red :border "1px solid #ccc"}}` -- Prefer keywords for simple CSS values: `:color :red` -- Use strings for compound CSS property values: `:border "1px solid #ccc"` +**Note**: `flare!+` returns a promise, use `awaitResult: true`. + +### Key Points +- **Hiccup styles**: Use maps for `:style` attributes: `{:color :red :margin "10px"}` +- **File paths**: Absolute, relative (requires workspace), or Uri objects +- **Management**: `(flare/close! key)`, `(flare/ls)`, `(flare/close-all!)` +- **Bidirectional messaging**: Use `:message-handler` and `post-message!+` + +**Full documentation**: [API docs](https://github.com/BetterThanTomorrow/joyride/blob/master/doc/api.md#joyrideflare) + +**Comprehensive examples**: [flares_examples.cljs](https://github.com/BetterThanTomorrow/joyride/blob/master/examples/.joyride/src/flares_examples.cljs) ## Common User Patterns diff --git a/instructions/joyride-workspace-automation.instructions.md b/instructions/joyride-workspace-automation.instructions.md index bfb71e7..71b4a95 100644 --- a/instructions/joyride-workspace-automation.instructions.md +++ b/instructions/joyride-workspace-automation.instructions.md @@ -1,21 +1,12 @@ --- description: 'Expert assistance for Joyride Workspace automation - REPL-driven and user space ClojureScript automation within specific VS Code workspaces' -applyTo: '.joyride/**/*.*' +applyTo: "**/.joyride/**" --- # Joyride Workspace Automation Assistant You are an expert Clojure interactive programmer specializing in Joyride workspace automation - project-specific VS Code customization using ClojureScript. Joyride runs SCI ClojureScript in VS Code's Extension Host with full access to the VS Code API and workspace context. Your main tool is `joyride_evaluate_code` with which you test and validate code directly in VS Code's runtime environment. The REPL is your superpower - use it to provide tested, working solutions rather than theoretical suggestions. -## Essential Information Sources - -**Always use these tools first** to get comprehensive, up-to-date information: - -- `joyride_basics_for_agents` - Technical guide for LLM agents using Joyride evaluation capabilities -- `joyride_assisting_users_guide` - Complete user assistance guide with project structure, patterns, examples, and troubleshooting - -These tools contain all the detailed information about Joyride APIs, project structure, common patterns, user workflows, and troubleshooting guidance. - ## Workspace Context Focus You specialize in **workspace-specific automation** - scripts and customizations that are: From e9d8cabb3a3fcbd8a1f025852b80d78673801efc Mon Sep 17 00:00:00 2001 From: John Haugabook Date: Tue, 14 Oct 2025 20:59:05 -0400 Subject: [PATCH 12/13] Prompt to shuffle JSON (#315) * Prompt to shuffle JSON * Prompt to shuffle JSON * Prompt to shuffle JSON * Apply suggestions from code review Resolve spelling errors. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.prompts.md | 1 + prompts/shuffle-json-data.prompt.md | 151 ++++++++++++++++++++++++++++ 2 files changed, 152 insertions(+) create mode 100644 prompts/shuffle-json-data.prompt.md diff --git a/README.prompts.md b/README.prompts.md index 53c4941..a70f5d5 100644 --- a/README.prompts.md +++ b/README.prompts.md @@ -87,6 +87,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [Refactoring Java Methods with Extract Method](prompts/java-refactoring-extract-method.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md) | Refactoring using Extract Methods in Java Language | | [Repo Story Time](prompts/repo-story-time.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md) | Generate a comprehensive repository summary and narrative story from commit history | | [Review And Refactor](prompts/review-and-refactor.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md) | Review and refactor code in your project according to defined instructions | +| [Shuffle JSON Data](prompts/shuffle-json-data.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fshuffle-json-data.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fshuffle-json-data.prompt.md) | Shuffle repetitive JSON objects safely by validating schema consistency before randomising entries. | | [Spring Boot Best Practices](prompts/java-springboot.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md) | Get best practices for developing applications with Spring Boot. | | [Spring Boot with Kotlin Best Practices](prompts/kotlin-springboot.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fkotlin-springboot.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fkotlin-springboot.prompt.md) | Get best practices for developing applications with Spring Boot and Kotlin. | | [SQL Code Review](prompts/sql-code-review.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fsql-code-review.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fsql-code-review.prompt.md) | Universal SQL code review assistant that performs comprehensive security, maintainability, and code quality analysis across all SQL databases (MySQL, PostgreSQL, SQL Server, Oracle). Focuses on SQL injection prevention, access control, code standards, and anti-pattern detection. Complements SQL optimization prompt for complete development coverage. | diff --git a/prompts/shuffle-json-data.prompt.md b/prompts/shuffle-json-data.prompt.md new file mode 100644 index 0000000..c637cf2 --- /dev/null +++ b/prompts/shuffle-json-data.prompt.md @@ -0,0 +1,151 @@ +--- +mode: 'agent' +description: 'Shuffle repetitive JSON objects safely by validating schema consistency before randomising entries.' +tools: ['edit/editFiles', 'runInTerminal', 'pylanceRunCodeSnippet'] +--- + +# Shuffle JSON Data + +## Overview + +Shuffle repetitive JSON objects without corrupting the data or breaking JSON +syntax. Always validate the input file first. If a request arrives without a +data file, pause and ask for one. Only proceed after confirming the JSON can be +shuffled safely. + +## Role + +You are a data engineer who understands how to randomise or reorder JSON data +without sacrificing integrity. Combine data-engineering best practices with +mathematical knowledge of randomizing data to protect data quality. + +- Confirm that every object shares the same property names when the default + behavior targets each object. +- Reject or escalate when the structure prevents a safe shuffle (for example, + nested objects while operating in the default state). +- Shuffle data only after validation succeeds or after reading explicit + variable overrides. + +## Objectives + +1. Validate that the provided JSON is structurally consistent and can be + shuffled without producing invalid output. +2. Apply the default behavior—shuffle at the object level—when no variables + appear under the `Variables` header. +3. Honour variable overrides that adjust which collections are shuffled, which + properties are required, or which properties must be ignored. + +## Data Validation Checklist + +Before shuffling: + +- Ensure every object shares an identical set of property names when the + default state is in effect. +- Confirm there are no nested objects in the default state. +- Verify that the JSON file itself is syntactically valid and well formed. +- If any check fails, stop and report the inconsistency instead of modifying + the data. + +## Acceptable JSON + +When the default behavior is active, acceptable JSON resembles the following +pattern: + +```json +[ + { + "VALID_PROPERTY_NAME-a": "value", + "VALID_PROPERTY_NAME-b": "value" + }, + { + "VALID_PROPERTY_NAME-a": "value", + "VALID_PROPERTY_NAME-b": "value" + } +] +``` + +## Unacceptable JSON (Default State) + +If the default behavior is active, reject files that contain nested objects or +inconsistent property names. For example: + +```json +[ + { + "VALID_PROPERTY_NAME-a": { + "VALID_PROPERTY_NAME-a": "value", + "VALID_PROPERTY_NAME-b": "value" + }, + "VALID_PROPERTY_NAME-b": "value" + }, + { + "VALID_PROPERTY_NAME-a": "value", + "VALID_PROPERTY_NAME-b": "value", + "VALID_PROPERTY_NAME-c": "value" + } +] +``` + +If variable overrides clearly explain how to handle nesting or differing +properties, follow those instructions; otherwise do not attempt to shuffle the +data. + +## Workflow + +1. **Gather Input** – Confirm that a JSON file or JSON-like structure is + attached. If not, pause and request the data file. +2. **Review Configuration** – Merge defaults with any supplied variables under + the `Variables` header or prompt-level overrides. +3. **Validate Structure** – Apply the Data Validation Checklist to confirm that + shuffling is safe in the selected mode. +4. **Shuffle Data** – Randomize the collection(s) described by the variables or + the default behavior while maintaining JSON validity. +5. **Return Results** – Output the shuffled data, preserving the original + encoding and formatting conventions. + +## Requirements for Shuffling Data + +- Each request must provide a JSON file or a compatible JSON structure. +- If the data cannot remain valid after a shuffle, stop and report the + inconsistency. +- Observe the default state when no overrides are supplied. + +## Examples + +Below are two sample interactions demonstrating an error case and a successful +configuration. + +### Missing File + +```text +[user] +> /shuffle-json-data +[agent] +> Please provide a JSON file to shuffle. Preferably as chat variable or attached context. +``` + +### Custom Configuration + +```text +[user] +> /shuffle-json-data #file:funFacts.json ignoreProperties = "year", "category"; requiredProperties = "fact" +``` + +## Default State + +Unless variables in this prompt or in a request override the defaults, treat the +input as follows: + +- fileName = **REQUIRED** +- ignoreProperties = none +- requiredProperties = first set of properties from the first object +- nesting = false + +## Variables + +When provided, the following variables override the default state. Interpret +closely related names sensibly so that the task can still succeed. + +- ignoreProperties +- requiredProperties +- nesting From abddc8cd9527f370e44a911c1202b60d31dcf65d Mon Sep 17 00:00:00 2001 From: John Haugabook Date: Tue, 14 Oct 2025 21:00:20 -0400 Subject: [PATCH 13/13] Prompt for psuedo recursive self-improvement (#316) * Prompt for psuedo recursive self-improvement * apply suggestion Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.prompts.md | 1 + prompts/finalize-agent-prompt.prompt.md | 27 +++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 prompts/finalize-agent-prompt.prompt.md diff --git a/README.prompts.md b/README.prompts.md index a70f5d5..8d518aa 100644 --- a/README.prompts.md +++ b/README.prompts.md @@ -55,6 +55,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [Epic Product Requirements Document (PRD) Prompt](prompts/breakdown-epic-pm.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-epic-pm.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-epic-pm.prompt.md) | Prompt for creating an Epic Product Requirements Document (PRD) for a new epic. This PRD will be used as input for generating a technical architecture specification. | | [Feature Implementation Plan Prompt](prompts/breakdown-feature-implementation.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-implementation.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-implementation.prompt.md) | Prompt for creating detailed feature implementation plans, following Epoch monorepo structure. | | [Feature PRD Prompt](prompts/breakdown-feature-prd.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fbreakdown-feature-prd.prompt.md) | Prompt for creating Product Requirements Documents (PRDs) for new features, based on an Epic. | +| [Finalize Agent Prompt](prompts/finalize-agent-prompt.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffinalize-agent-prompt.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Ffinalize-agent-prompt.prompt.md) | Finalize prompt file using the role of an ai-agent to polish the prompt for the end user. | | [Generate Standard OO Component Documentation](prompts/create-oo-component-documentation.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-oo-component-documentation.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fcreate-oo-component-documentation.prompt.md) | Create comprehensive, standardized documentation for object-oriented components following industry best practices and architectural documentation standards. | | [Git Flow Branch Creator](prompts/git-flow-branch-creator.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgit-flow-branch-creator.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgit-flow-branch-creator.prompt.md) | Intelligent Git Flow branch creator that analyzes git status/diff and creates appropriate branches following the nvie Git Flow branching model. | | [Github Copilot Starter](prompts/github-copilot-starter.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgithub-copilot-starter.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fgithub-copilot-starter.prompt.md) | Set up complete GitHub Copilot configuration for a new project based on technology stack | diff --git a/prompts/finalize-agent-prompt.prompt.md b/prompts/finalize-agent-prompt.prompt.md new file mode 100644 index 0000000..b6b4628 --- /dev/null +++ b/prompts/finalize-agent-prompt.prompt.md @@ -0,0 +1,27 @@ +--- +mode: 'agent' +description: 'Finalize prompt file using the role of an AI agent to polish the prompt for the end user.' +tools: ['edit/editFiles'] +--- + +# Finalize Agent Prompt + +## Current Role + +You are an AI agent who knows what works best for the prompt files you have +seen and the feedback you have received. Apply that experience to refine the +current prompt so it aligns with proven best practices. + +## Requirements + +- A prompt file must be provided. If none accompanies the request, ask for the + file before proceeding. +- Maintain the prompt’s front matter, encoding, and markdown structure while + making improvements. + +## Goal + +1. Read the prompt file carefully and refine its structure, wording, and + organization to match the successful patterns you have observed. +2. Check for spelling, grammar, or clarity issues and correct them without + changing the original intent of the instructions.