docs(maintenance): readme updated

[vaibhavbhalla2505]

Description

This pull request updates the documentation and clarifies internal comments to improve onboarding and usage for the loopback4-mcp extension. The main focus is on making the README.md more beginner-friendly, providing concrete usage examples, and clarifying how MCP tool hooks work. Additionally, minor clarifying comments were added in the service implementation.

Fixes #5

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Intermediate change (work in progress)

Checklist:

• Performed a self-review of my own code
• npm test passes on your machine
• New tests added or existing tests modified to cover all changes
• Code conforms with the style guide
• API Documentation in code was updated
• Any dependent changes have been merged and published in downstream modules

[sonarqubecloud]

SonarQube reviewer guide

Summary: Documentation improvements and code clarity enhancements for MCP tool integration.

Review Focus: Expanded README with clearer setup instructions, added requirement for @param decorators on MCP tool methods, and improved code formatting/comments.

Start review at: README.md. This contains the critical new requirement that all MCP tool methods must use @param decorators, which is a breaking change or important constraint for users.

💬 Please send your feedback

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[yeshamavani]

🎉 This PR is included in version 1.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀