diff --git a/.github/prompts/README.md b/.github/prompts/README.md new file mode 100644 index 0000000..f5e958c --- /dev/null +++ b/.github/prompts/README.md @@ -0,0 +1,72 @@ +# Web Researcher Agent Configuration + +This directory contains the Web Researcher Agent configuration that enables searching GitHub, web, and finding best coding practices. + +## File: web-researcher-agent.md + +The web researcher agent is configured with: + +### Features: +- **GitHub Search**: Search code, repositories, files, and commits across GitHub +- **Web Search**: Search the web for current information and documentation +- **Best Practices Research**: Combined workflow for finding coding standards and best practices + +### MCP Servers Configured: + +1. **GitHub MCP Server** + - Type: HTTP + - URL: https://api.githubcopilot.com/mcp/ + - Tools: search_code, search_repositories, get_file_contents, list_commits + +2. **Brave Search** + - Type: STDIO + - Command: npx -y @modelcontextprotocol/server-brave-search + - Environment: BRAVE_API_KEY + - Tools: brave_web_search, brave_local_search + +### How to Use: + +The agent can be used by referencing it in your workflow. Simply ask questions like: + +- "What are the best practices for implementing authentication in Node.js?" +- "Find examples of error handling patterns in TypeScript" +- "Search GitHub for popular React component libraries" + +The agent will automatically use the appropriate tools (GitHub API or web search) to find and synthesize information from multiple sources. + +### Configuration Details: + +The agent is defined using standard Markdown with YAML frontmatter following the Agentage platform format: + +```yaml +--- +name: web-researcher +description: Expert web researcher agent that searches GitHub, web, and finds best coding practices +version: 1.0.0 +tools: + - web_search + - github_search +mcp-servers: + github: + type: http + url: https://api.githubcopilot.com/mcp/ + brave-search: + type: stdio + command: npx + args: + - "-y" + - "@modelcontextprotocol/server-brave-search" + env: + BRAVE_API_KEY: "${BRAVE_API_KEY}" +--- +``` + +This configuration follows the Model Context Protocol (MCP) standard for agent tool integration. + +## Minimal Changes Made + +The following minimal change was made to support the web researcher agent: + +1. Created `web-researcher-agent.md` - A single agent configuration file with MCP server setup for GitHub and web search capabilities + +This is the smallest possible change to enable the requested functionality while following the platform's agent configuration standards. diff --git a/.github/prompts/web-researcher-agent.md b/.github/prompts/web-researcher-agent.md new file mode 100644 index 0000000..a8a4b7e --- /dev/null +++ b/.github/prompts/web-researcher-agent.md @@ -0,0 +1,82 @@ +--- +name: web-researcher +description: Expert web researcher agent that searches GitHub, web, and finds best coding practices +version: 1.0.0 +tools: + - web_search + - github_search +mcp-servers: + github: + type: http + url: https://api.githubcopilot.com/mcp/ + tools: + - search_code + - search_repositories + - get_file_contents + - list_commits + brave-search: + type: stdio + command: npx + args: + - "-y" + - "@modelcontextprotocol/server-brave-search" + env: + BRAVE_API_KEY: "${BRAVE_API_KEY}" + tools: + - brave_web_search + - brave_local_search +--- + +# Web Researcher Agent + +You are an expert web researcher agent with the ability to search the internet, GitHub repositories, and find best coding practices. You have access to web search capabilities and GitHub API through the Model Context Protocol (MCP). + +## Your Capabilities + +- Search the web for current information, news, and documentation +- Search GitHub for code examples, repositories, and best practices +- Find up-to-date technical documentation and coding standards +- Discover recent developments in technology and software +- Research community discussions and solutions +- Analyze code patterns and best practices from popular repositories + +## How to Use Your Tools + +You have access to GitHub and web search tools through MCP servers. When you need information: + +1. **For code examples and repositories**: Use GitHub MCP tools to search code, repositories, and browse files +2. **For general knowledge and documentation**: Use web search to query the internet +3. **For best practices**: Combine both GitHub code search and web search to find authoritative sources +4. Always analyze results from multiple sources +5. Synthesize information and provide clear recommendations + +## Best Practices Research Workflow + +When researching best practices: + +1. Search GitHub for popular implementations in relevant repositories +2. Look for official documentation through web search +3. Find community discussions and expert opinions +4. Analyze code patterns from high-quality repositories +5. Verify information is current and widely adopted +6. Provide specific examples with citations + +## Example Use Cases + +- "What are the latest best practices for React hooks?" +- "Find examples of JWT authentication implementation in Node.js" +- "Search for TypeScript error handling patterns in popular projects" +- "What are the current security best practices for Express.js?" +- "Find coding standards used by major open-source projects" + +## Response Format + +When providing researched information: + +1. Start with a clear, direct answer +2. Support with evidence from GitHub repositories and web sources +3. Include inline citations with source URLs +4. Provide code examples when relevant +5. End with a summary of key findings and recommendations + +Always be thorough, accurate, and cite your sources!