From 721e1806dfab44727cb7854ac6a82b4b6cd00032 Mon Sep 17 00:00:00 2001 From: Oscar V Date: Mon, 24 Nov 2025 22:56:03 -0800 Subject: [PATCH] moving documentation to commmunity --- README.md | 84 ------------------------------------------------------- 1 file changed, 84 deletions(-) diff --git a/README.md b/README.md index e823ecc..ee0188b 100644 --- a/README.md +++ b/README.md @@ -203,90 +203,6 @@ python agent.py interactive See the [example directory](examples/strands-agent-ollama/) for full details. -## IDE Integration - -Use SEMCL.ONE tools directly within your AI-powered IDE for seamless OSS compliance analysis during development. - -### Supported IDEs - -- **Cursor IDE** - AI-first code editor -- **Cline** - AI coding extension for VS Code -- **Kiro IDE** - Amazon's agentic AI IDE -- **VS Code** - With MCP extension -- **JetBrains IDEs** - With AI plugin - -### Quick Setup - -1. **Install mcp-semclone** with pipx (recommended): - ```bash - pipx install mcp-semclone - pipx inject mcp-semclone purl2notices osslili binarysniffer ospac vulnq upmex - ``` - -2. **Configure your IDE** - Add MCP server configuration (see guide for IDE-specific paths) - -3. **Restart your IDE** - -### Use Cases in IDEs - -Once integrated, ask your IDE's AI: -- "Check this project for license compliance issues" -- "What licenses are used in my dependencies?" -- "Is this package safe for commercial distribution?" -- "Generate SBOM for this release" -- "Create NOTICE file for mobile app" - -**📖 Complete documentation**: See [IDE Integration Guide](guides/IDE_INTEGRATION_GUIDE.md) - -## Development - -### Running Tests - -```bash -# Run all tests -pytest - -# Run with coverage -pytest --cov=mcp_semclone tests/ - -# Run specific test -pytest tests/test_server.py -v -``` - -### Building - -```bash -# Build package -python -m build - -# Install locally for testing -pip install -e . -``` - -## Troubleshooting - -### Common Issues - -1. **Tools not found**: Ensure all SEMCL.ONE tools are installed and in PATH -2. **API rate limits**: Add API keys to environment variables -3. **Permission errors**: Check file/directory permissions -4. **Large codebases**: Use recursive=False or limit scan depth - -### Debug Mode - -Enable debug logging: - -```bash -export MCP_LOG_LEVEL=DEBUG -python -m mcp_semclone.server -``` - -## Security Considerations - -- API keys are optional but recommended for production use -- The server runs tools via subprocess with user permissions -- Vulnerability data is fetched from public APIs -- No data is sent to external services without explicit tool calls ## Contributing