hawkeye-mcp-server 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/CHANGELOG.md +123 -0
  2. package/INSTALLATION.md +734 -0
  3. package/LICENSE +21 -0
  4. package/README.md +289 -0
  5. package/SPECIFICATION.md +1073 -0
  6. package/USAGE.md +849 -0
  7. package/build/config/config.d.ts +58 -0
  8. package/build/config/config.js +100 -0
  9. package/build/config/config.js.map +1 -0
  10. package/build/index.d.ts +6 -0
  11. package/build/index.js +138 -0
  12. package/build/index.js.map +1 -0
  13. package/build/services/auth.service.d.ts +34 -0
  14. package/build/services/auth.service.js +96 -0
  15. package/build/services/auth.service.js.map +1 -0
  16. package/build/services/project.service.d.ts +50 -0
  17. package/build/services/project.service.js +136 -0
  18. package/build/services/project.service.js.map +1 -0
  19. package/build/services/session.service.d.ts +68 -0
  20. package/build/services/session.service.js +357 -0
  21. package/build/services/session.service.js.map +1 -0
  22. package/build/tools/continue-investigation.d.ts +10 -0
  23. package/build/tools/continue-investigation.js +84 -0
  24. package/build/tools/continue-investigation.js.map +1 -0
  25. package/build/tools/get-incident-report.d.ts +10 -0
  26. package/build/tools/get-incident-report.js +62 -0
  27. package/build/tools/get-incident-report.js.map +1 -0
  28. package/build/tools/get-session-report.d.ts +25 -0
  29. package/build/tools/get-session-report.js +46 -0
  30. package/build/tools/get-session-report.js.map +1 -0
  31. package/build/tools/get-session-summary.d.ts +22 -0
  32. package/build/tools/get-session-summary.js +41 -0
  33. package/build/tools/get-session-summary.js.map +1 -0
  34. package/build/tools/get-status.d.ts +10 -0
  35. package/build/tools/get-status.js +129 -0
  36. package/build/tools/get-status.js.map +1 -0
  37. package/build/tools/index.d.ts +29 -0
  38. package/build/tools/index.js +349 -0
  39. package/build/tools/index.js.map +1 -0
  40. package/build/tools/inspect-session.d.ts +28 -0
  41. package/build/tools/inspect-session.js +51 -0
  42. package/build/tools/inspect-session.js.map +1 -0
  43. package/build/tools/investigate-alert.d.ts +10 -0
  44. package/build/tools/investigate-alert.js +122 -0
  45. package/build/tools/investigate-alert.js.map +1 -0
  46. package/build/tools/list-sessions.d.ts +49 -0
  47. package/build/tools/list-sessions.js +79 -0
  48. package/build/tools/list-sessions.js.map +1 -0
  49. package/build/types/errors.d.ts +61 -0
  50. package/build/types/errors.js +76 -0
  51. package/build/types/errors.js.map +1 -0
  52. package/build/types/hawkeye.d.ts +238 -0
  53. package/build/types/hawkeye.js +8 -0
  54. package/build/types/hawkeye.js.map +1 -0
  55. package/build/types/mcp.d.ts +125 -0
  56. package/build/types/mcp.js +6 -0
  57. package/build/types/mcp.js.map +1 -0
  58. package/build/utils/errors.d.ts +20 -0
  59. package/build/utils/errors.js +125 -0
  60. package/build/utils/errors.js.map +1 -0
  61. package/build/utils/http-client.d.ts +51 -0
  62. package/build/utils/http-client.js +133 -0
  63. package/build/utils/http-client.js.map +1 -0
  64. package/build/utils/logger.d.ts +35 -0
  65. package/build/utils/logger.js +77 -0
  66. package/build/utils/logger.js.map +1 -0
  67. package/build/utils/validation.d.ts +134 -0
  68. package/build/utils/validation.js +68 -0
  69. package/build/utils/validation.js.map +1 -0
  70. package/package.json +66 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,123 @@
1
+ # Changelog
2
+
3
+ All notable changes to the Hawkeye MCP Server will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [1.0.0] - 2024-11-19
9
+
10
+ ### Added
11
+
12
+ #### Core Features
13
+ - Initial release of Hawkeye MCP Server
14
+ - Full Model Context Protocol (MCP) implementation
15
+ - Authentication service with token caching and automatic refresh
16
+ - Project management and selection
17
+ - Session management and investigation lifecycle
18
+
19
+ #### Investigation Tools
20
+ - `hawkeye_list_projects` - List all available Hawkeye projects
21
+ - `hawkeye_investigate_alert` - Find existing RCAs or create new investigations for alert IDs
22
+ - `hawkeye_get_investigation_status` - Check investigation progress and results
23
+ - `hawkeye_continue_investigation` - Ask follow-up questions on existing investigations
24
+
25
+ #### Session Management & Analytics
26
+ - `hawkeye_list_sessions` - List sessions with advanced filtering capabilities:
27
+ - Pagination support (page/limit parameters)
28
+ - Date range filtering (date_from/date_to)
29
+ - Investigation status filtering (uninvestigated, in progress, completed)
30
+ - Session type filtering (incident vs manual)
31
+ - Convenience parameter `only_uninvestigated` for quick filtering
32
+ - Option to hide grouped incidents
33
+ - `hawkeye_inspect_session` - Get detailed session information with:
34
+ - All prompt cycles
35
+ - Chain of thoughts (analysis steps)
36
+ - Data sources used
37
+ - Follow-up suggestions
38
+ - `hawkeye_get_session_report` - Get session summaries with time-saved metrics
39
+ - `hawkeye_get_session_summary` - Get detailed quality scores and analysis metrics
40
+ - `hawkeye_get_incident_report` - Get organization-wide analytics:
41
+ - MTTR (Mean Time To Resolution)
42
+ - Total time saved
43
+ - Noise reduction percentage
44
+ - Incident breakdown by type and priority
45
+
46
+ #### Configuration & Environment
47
+ - Comprehensive environment variable support
48
+ - Configurable polling and timeouts
49
+ - Optional logging configuration
50
+ - Default project and organization settings
51
+
52
+ #### Documentation
53
+ - Comprehensive README with quick start guide
54
+ - Detailed INSTALLATION.md with platform-specific instructions
55
+ - Complete USAGE.md with workflows and examples
56
+ - Technical SPECIFICATION.md with API reference
57
+ - MIT License
58
+
59
+ ### Changed
60
+ - Standardized all environment variables to use `HAWKEYE_` prefix (was `RAVEN_`)
61
+ - Package renamed from `raven-api-services` to `hawkeye-mcp-server`
62
+ - Updated to public npm package (was private)
63
+
64
+ ### Technical Details
65
+ - Node.js >= 20.0.0 required
66
+ - Built with TypeScript for type safety
67
+ - Uses @modelcontextprotocol/sdk ^1.10.0
68
+ - HTTP client with Axios ^1.9.0
69
+ - Runtime validation with Zod ^3.24.3
70
+
71
+ ### Supported Platforms
72
+ - macOS (Intel and Apple Silicon)
73
+ - Windows 10/11
74
+ - Linux (Ubuntu, Debian, Fedora, etc.)
75
+
76
+ ### Supported AI Agents
77
+ - Claude Desktop (macOS, Windows)
78
+ - Cursor.ai (macOS, Windows, Linux)
79
+ - Continue.dev (VS Code extension)
80
+ - Any MCP-compatible AI agent
81
+
82
+ ---
83
+
84
+ ## [Unreleased]
85
+
86
+ ### Planned Features
87
+ - Custom investigation creation with natural language timeframes
88
+ - Streaming support for real-time progress updates
89
+ - Interactive setup wizard (`hawkeye-mcp init`)
90
+ - Health check command (`hawkeye-mcp test-connection`)
91
+ - CLI flags (`--version`, `--help`)
92
+ - Additional filtering options (priority, incident type)
93
+ - Pre-built binaries for platforms without Node.js
94
+
95
+ ---
96
+
97
+ ## How to Update
98
+
99
+ ### For Users
100
+
101
+ ```bash
102
+ # Update to latest version
103
+ npm update -g hawkeye-mcp-server
104
+
105
+ # Or reinstall
106
+ npm install -g hawkeye-mcp-server@latest
107
+ ```
108
+
109
+ ### For npx Users
110
+
111
+ npx automatically uses the latest version, but you can force a cache clear:
112
+
113
+ ```bash
114
+ # Clear npx cache and use latest
115
+ npx clear-npx-cache
116
+ npx hawkeye-mcp-server
117
+ ```
118
+
119
+ ---
120
+
121
+ ## Support
122
+
123
+ For questions or issues, contact support@neubird.ai