Add rules for developing with cursor

Author: garrmark

.cursor/rules/about-codebase.mdc

@@ -0,0 +1,8 @@
+---
+description: General information about the CodeLogic MCP Server codebase and its purpose
+globs: 
+alwaysApply: false
+---
+- This repository contains a Model Context Protocol (MCP) server that integrates with CodeLogic's knowledge graph APIs
+- It enables AI programming assistants to access dependency data from CodeLogic to analyze code and database impacts
+- The core package is in src/codelogic_mcp_server/ with server.py, handlers.py, and utils.py

.cursor/rules/best-practices.mdc

@@ -0,0 +1,8 @@
+---
+description: Best practices for working with the CodeLogic MCP Server codebase
+globs: 
+alwaysApply: false
+---
+- Use semantic search before grep for broader context
+- Maintain proper error handling and logging
+- Keep code changes atomic and focused

.cursor/rules/codelogic-rules.md

@@ -0,0 +1,9 @@
+---
+description: Debugging guidance for the CodeLogic MCP Server
+globs: "**/*.py"
+alwaysApply: false
+---
+- Enable Debug Mode by setting `CODELOGIC_DEBUG_MODE=true`
+- Use debugpy capabilities for remote debugging
+- Check logs in the logs directory for detailed information
+- Use proper logging levels for different types of information

.cursor/rules/debugging.mdc

@@ -0,0 +1,11 @@
+---
+description: Key environment variables for the CodeLogic MCP Server
+globs: "**/*.py"
+alwaysApply: false
+---
+- `CODELOGIC_SERVER_HOST`: CodeLogic server URL
+- `CODELOGIC_USERNAME`: Username for authentication
+- `CODELOGIC_PASSWORD`: Password for authentication
+- `CODELOGIC_WORKSPACE_NAME`: Workspace name
+- `CODELOGIC_DEBUG_MODE`: Enable debug logging
+- `CODELOGIC_TEST_MODE`: Used by test framework

.cursor/rules/environment-variables.mdc

@@ -0,0 +1,16 @@
+---
+description: Error handling patterns for the CodeLogic MCP Server
+globs: "**/*.py"
+alwaysApply: false
+---
+- Use the following pattern for error handling in tool implementations:
+```python
+try:
+    # Operations that might fail
+except Exception as e:
+    sys.stderr.write(f"Error: {str(e)}\n")
+    return [types.TextContent(type="text", text=f"# Error\n\n{str(e)}")]
+```
+- Always catch and report exceptions
+- Write errors to stderr
+- Return formatted error messages to the client

.cursor/rules/error-handling.mdc

@@ -0,0 +1,9 @@
+---
+description: File operation guidance for working with the CodeLogic MCP Server
+globs: 
+alwaysApply: false
+---
+- Direct file editing with context preservation
+- File creation and deletion capabilities
+- Directory listing and navigation
+- Maintain proper file organization and structure

.cursor/rules/file-operations.mdc

@@ -0,0 +1,21 @@
+---
+description: Core coding patterns for MCP Server implementation
+globs: "**/*.py"
+alwaysApply: false
+---
+- Use the following pattern for MCP server implementation:
+```python
+server = Server("codelogic-mcp-server")
+
+@server.list_tools()
+async def handle_list_tools() -> list[types.Tool]:
+    # Define and return tools
+    
+@server.call_tool()
+async def handle_call_tool(name: str, arguments: dict | None) -> list[types.TextContent]:
+    # Handle tool execution
+```
+- New tools should be added to handle_list_tools() with descriptive names (prefix: `codelogic-`)
+- Tool handlers should be implemented in handle_call_tool()
+- Create handler functions with proper error handling
+- Return results as markdown-formatted text

.cursor/rules/mcp-server-pattern.mdc

@@ -0,0 +1,10 @@
+---
+description: Style guidelines for the CodeLogic MCP Server project
+globs: "**/*.py"
+alwaysApply: false
+---
+- Include MPL 2.0 copyright headers in all Python files
+- Use Google-style docstrings for modules/classes/functions
+- Always use Python type hints
+- Keep I/O operations asynchronous
+- Return markdown-formatted text in tool responses

.cursor/rules/style-guidelines.mdc

@@ -0,0 +1,9 @@
+---
+description: Key technologies used in the CodeLogic MCP Server project
+globs: 
+alwaysApply: false
+---
+- Python 3.13+ with extensive use of async/await
+- Model Context Protocol SDK (`mcp[cli]`)
+- HTTPX for API requests
+- Environment variables via dotenv for configuration

.cursor/rules/technologies.mdc

@@ -0,0 +1,9 @@
+---
+description: Testing approach for the CodeLogic MCP Server
+globs: "**/test/*.py"
+alwaysApply: false
+---
+- Use unit tests for functions without external dependencies
+- Use integration tests for tests against a real CodeLogic server
+- Set the `CODELOGIC_TEST_MODE` environment variable for test runs
+- Test both success cases and error handling patterns