Skip to content

Commit ed2e5c2

Browse files
Merge pull request #35 from SemClone/docs/move-to-community
docs: Move documentation to community
2 parents f4e7c5c + 721e180 commit ed2e5c2

File tree

1 file changed

+0
-84
lines changed

1 file changed

+0
-84
lines changed

README.md

Lines changed: 0 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -203,90 +203,6 @@ python agent.py interactive
203203

204204
See the [example directory](examples/strands-agent-ollama/) for full details.
205205

206-
## IDE Integration
207-
208-
Use SEMCL.ONE tools directly within your AI-powered IDE for seamless OSS compliance analysis during development.
209-
210-
### Supported IDEs
211-
212-
- **Cursor IDE** - AI-first code editor
213-
- **Cline** - AI coding extension for VS Code
214-
- **Kiro IDE** - Amazon's agentic AI IDE
215-
- **VS Code** - With MCP extension
216-
- **JetBrains IDEs** - With AI plugin
217-
218-
### Quick Setup
219-
220-
1. **Install mcp-semclone** with pipx (recommended):
221-
```bash
222-
pipx install mcp-semclone
223-
pipx inject mcp-semclone purl2notices osslili binarysniffer ospac vulnq upmex
224-
```
225-
226-
2. **Configure your IDE** - Add MCP server configuration (see guide for IDE-specific paths)
227-
228-
3. **Restart your IDE**
229-
230-
### Use Cases in IDEs
231-
232-
Once integrated, ask your IDE's AI:
233-
- "Check this project for license compliance issues"
234-
- "What licenses are used in my dependencies?"
235-
- "Is this package safe for commercial distribution?"
236-
- "Generate SBOM for this release"
237-
- "Create NOTICE file for mobile app"
238-
239-
**📖 Complete documentation**: See [IDE Integration Guide](guides/IDE_INTEGRATION_GUIDE.md)
240-
241-
## Development
242-
243-
### Running Tests
244-
245-
```bash
246-
# Run all tests
247-
pytest
248-
249-
# Run with coverage
250-
pytest --cov=mcp_semclone tests/
251-
252-
# Run specific test
253-
pytest tests/test_server.py -v
254-
```
255-
256-
### Building
257-
258-
```bash
259-
# Build package
260-
python -m build
261-
262-
# Install locally for testing
263-
pip install -e .
264-
```
265-
266-
## Troubleshooting
267-
268-
### Common Issues
269-
270-
1. **Tools not found**: Ensure all SEMCL.ONE tools are installed and in PATH
271-
2. **API rate limits**: Add API keys to environment variables
272-
3. **Permission errors**: Check file/directory permissions
273-
4. **Large codebases**: Use recursive=False or limit scan depth
274-
275-
### Debug Mode
276-
277-
Enable debug logging:
278-
279-
```bash
280-
export MCP_LOG_LEVEL=DEBUG
281-
python -m mcp_semclone.server
282-
```
283-
284-
## Security Considerations
285-
286-
- API keys are optional but recommended for production use
287-
- The server runs tools via subprocess with user permissions
288-
- Vulnerability data is fetched from public APIs
289-
- No data is sent to external services without explicit tool calls
290206

291207
## Contributing
292208

0 commit comments

Comments
 (0)