diff --git a/docs/docs/img/.DS_Store b/docs/docs/img/.DS_Store new file mode 100644 index 0000000..5008ddf Binary files /dev/null and b/docs/docs/img/.DS_Store differ diff --git a/docs/docs/img/mcp-server.gif b/docs/docs/img/mcp-server.gif new file mode 100644 index 0000000..a00bd62 Binary files /dev/null and b/docs/docs/img/mcp-server.gif differ diff --git a/docs/docs/img/mcp-server.png b/docs/docs/img/mcp-server.png deleted file mode 100644 index dd9a876..0000000 Binary files a/docs/docs/img/mcp-server.png and /dev/null differ diff --git a/docs/docs/intro.mdx b/docs/docs/intro.mdx index 00339b8..7a3a4fa 100644 --- a/docs/docs/intro.mdx +++ b/docs/docs/intro.mdx @@ -15,7 +15,11 @@ With the MCP Database Server, you can: - Export query results as CSV or JSON - Track business insights discovered during database analysis -![MCP Database Server](./img/mcp-server.png) +![MCP Database Server](./img/mcp-server.gif) + +:::tip What's New +Check our [Release Notes](./release-notes) to see what's new in version 1.0.2! +::: ## Installation diff --git a/docs/docs/release-notes.md b/docs/docs/release-notes.md new file mode 100644 index 0000000..1140b9b --- /dev/null +++ b/docs/docs/release-notes.md @@ -0,0 +1,56 @@ +# Release Notes + +## Version 1.0.2 (Current) + +**Release Date:** April 2025 + +### New Features +- Complete overhaul of documentation with new Docusaurus implementation +- Updated branding with blue color scheme +- Added comprehensive connection reference guide +- Improved database tools documentation +- New getting started guide for easier onboarding + +### Improvements +- Better error handling for database connections +- Enhanced SQL query performance, particularly for large result sets +- Updated Node.js dependencies to the latest stable versions +- Improved security for credential handling +- Added environment variable support for sensitive connection information + +### Bug Fixes +- Fixed connection issue with SQL Server when using Windows Authentication +- Corrected error in PostgreSQL RETURNING clause handling +- Addressed memory leak in connection pooling +- Fixed date formatting in SQLite exports + +## Version 1.0.1 + +**Release Date:** April 2025 + +### New Features +- Initial support for PostgreSQL databases +- Added export functionality for CSV and JSON formats +- Introduced business insights tracking with memo feature + +### Improvements +- Enhanced error reporting for failed queries +- Better handling of large result sets +- Optimized connection pooling for SQL Server + +### Bug Fixes +- Fixed SQL Server authentication with special characters in password +- Addressed timeout issues with long-running queries +- Resolved schema detection problems with certain table names + +## Version 1.0.0 + +**Release Date:** April 2025 + +### Initial Release Features +- Support for SQLite and SQL Server databases +- Basic SQL query execution (SELECT, INSERT, UPDATE, DELETE) +- Table management (CREATE, ALTER, DROP) +- Schema introspection +- MCP integration for Claude Desktop +- Node.js-based implementation for cross-platform support \ No newline at end of file diff --git a/docs/sidebars.ts b/docs/sidebars.ts index 732ff89..1e6ae94 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -19,12 +19,15 @@ const sidebars: SidebarsConfig = { // But you can create a sidebar manually tutorialSidebar: [ 'intro', + 'release-notes', 'getting-started', { type: 'category', label: 'Database Setup', items: [ 'sqlite-setup', + 'sql-server-setup', + 'postgresql-setup', 'connection-reference', ], }, diff --git a/package-lock.json b/package-lock.json index b2e3e04..de0322c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@executeautomation/database-server", - "version": "1.0.1", + "version": "1.0.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@executeautomation/database-server", - "version": "1.0.1", + "version": "1.0.2", "license": "MIT", "dependencies": { "@modelcontextprotocol/sdk": "1.9.0",