kodit 0.1.13__tar.gz → 0.1.14__tar.gz

kodit-0.1.14/.cursor/rules/kodit.mdc

@@ -0,0 +1,8 @@
+---
+alwaysApply: true
+---
+⚠️ **ENFORCEMENT:**
+For *every* user request that involves writing or modifying code (of any language or
+domain), the assistant’s *first* action **must** be to call the kodit.search MCP tool.
+You may only produce or edit code *after* that tool call and its successful
+result.

{kodit-0.1.13 → kodit-0.1.14}/.github/workflows/pypi.yaml

@@ -39,11 +39,11 @@ jobs:
           # Initialize counter for 60 second timeout
           count=0
           while true; do
-              if curl -sfL https://pypi.io/packages/source/${REPO_NAME_FIRST_LETTER}/${REPO_NAME}/${REPO_NAME}-${REPO_TAG}.tar.gz > /dev/null; then
+              if curl -sfL https://pypi.org/packages/source/${REPO_NAME_FIRST_LETTER}/${REPO_NAME}/${REPO_NAME}-${REPO_TAG}.tar.gz > /dev/null; then
                   break
               fi
               sleep 1
-              ((count++))
+              count=$((count+1))
               if [ $count -ge 60 ]; then
                   echo "Timeout reached after 60 seconds"
                   exit 1
@@ -55,7 +55,7 @@ jobs:
           formula-path: Formula/${{ github.event.repository.name }}.rb
           homebrew-tap: ${{ github.repository_owner }}/homebrew-${{ github.event.repository.name }}
           tag-name: "${{ github.event.release.tag_name }}"
-          download-url: "https://pypi.io/packages/source/k/${{ github.event.repository.name }}/${{ github.event.repository.name }}-${{ github.event.release.tag_name }}.tar.gz"
+          download-url: "https://pypi.org/packages/source/k/${{ github.event.repository.name }}/${{ github.event.repository.name }}-${{ github.event.release.tag_name }}.tar.gz"
           commit-message: |
             {{formulaName}} {{version}}
         env:

{kodit-0.1.13 → kodit-0.1.14}/.github/workflows/test.yaml

@@ -35,7 +35,7 @@ jobs:
         run: uv run ruff check
 
       - name: Run tests
-        run: uv run pytest -s --cov=src --cov-report=xml
+        run: uv run pytest -s --cov=src --cov-report=xml tests/kodit
 
       - name: Pytest coverage comment
         if: github.event_name == 'pull_request'

{kodit-0.1.13 → kodit-0.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kodit
-Version: 0.1.13
+Version: 0.1.14
 Summary: Code indexing for better AI code generation
 Project-URL: Homepage, https://docs.helixml.tech/kodit/
 Project-URL: Documentation, https://docs.helixml.tech/kodit/

{kodit-0.1.13 → kodit-0.1.14}/docs/_index.md

@@ -68,38 +68,29 @@ server to expose your code to an AI coding assistant.
 
 Now add the Kodit MCP server to your AI coding assistant.
 
-### Integration with Cursor
+### Integrating Kodit with Coding Assistants
 
-Add the following to `.cursor/mcp.json`:
+#### Integration with Cursor
+
+Add the following to `$HOME/.cursor/mcp.json`:
 
 ```json
 {
   "mcpServers": {
-    "code-search": {
+    "kodit": {
       "url": "http://localhost:8080/sse"
     }
   }
 }
 ```
 
-Now add the following prompt to `.cursor/rules/kodit.mdc` in your project directory:
-
-```markdown
----
-description: 
-globs: 
-alwaysApply: true
----
-You MUST use the code-search MCP tool and always include any file context the user has provided in the chat.
-```
-
-Alternatively, you can browse to the cursor settings and set this prompt globally.
+Or find this configuration in `Cursor Settings` -> `MCP`.
 
-### Integration with Cline
+#### Integration with Cline
 
-1. Click on the Cline icon in the menu
-2. Click the `MCP Servers` button at the top right of the Cline window (looks like a
-   server)
+1. Open Cline from the side menu
+2. Click the `MCP Servers` button at the top right of the Cline window (the icon looks
+   like a server)
 3. Click the `Remote Servers` tab.
 4. Click `Edit Configuration`
 5. Add the following configuration:
@@ -122,6 +113,49 @@ Alternatively, you can browse to the cursor settings and set this prompt globall
 
 Kodit should be listed and responding. Now code on!
 
+### Forcing AI Assistants to use Kodit
+
+Although Kodit has been developed to work well out of the box with popular AI coding
+assistants, they sometimes still think they know better.
+
+You can force your assistant to use Kodit by editing the system prompt used by the
+assistant. Each assistant exposes this slightly differently, but it's usually in the
+settings.
+
+Try using this system prompt:
+
+```txt
+⚠️ **ENFORCEMENT:**
+For *every* user request that involves writing or modifying code (of any language or
+domain), the assistant's *first* action **must** be to call the kodit.search MCP tool.
+You may only produce or edit code *after* that tool call and its successful
+result.
+```
+
+Feel free to alter that to suit your specific circumstances.
+
+#### Forcing Cursor to Use Kodit
+
+Add the following prompt to `.cursor/rules/kodit.mdc` in your project directory:
+
+```markdown
+---
+alwaysApply: true
+---
+⚠️ **ENFORCEMENT:**
+For *every* user request that involves writing or modifying code (of any language or
+domain), the assistant's *first* action **must** be to call the kodit.search MCP tool.
+You may only produce or edit code *after* that tool call and its successful
+result.
+```
+
+Alternatively, you can browse to the Cursor settings and set this prompt globally.
+
+#### Forcing Cline to Use Kodit
+
+1. Go to `Settings` -> `API Configuration`
+2. At the bottom there is a `Custom Instructions` section.
+
 ## Configuring Kodit
 
 Configuration of Kodit is performed by setting environmental variables or adding

{kodit-0.1.13 → kodit-0.1.14}/src/kodit/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.13'
-__version_tuple__ = version_tuple = (0, 1, 13)
+__version__ = version = '0.1.14'
+__version_tuple__ = version_tuple = (0, 1, 14)

{kodit-0.1.13 → kodit-0.1.14}/src/kodit/mcp.py

@@ -53,7 +53,16 @@ async def mcp_lifespan(_: FastMCP) -> AsyncIterator[MCPContext]:
         yield MCPContext(session=session, app_context=app_context)
 
 
-mcp = FastMCP("kodit MCP Server", lifespan=mcp_lifespan)
+mcp = FastMCP(
+    "Kodit",
+    lifespan=mcp_lifespan,
+    # Note that instructions are not used by Cline.
+    instructions=(
+        "This server is used to assist with code generation by retrieving "
+        "code examples related to the user's intent."
+        "Call search() to retrieve relevant code examples."
+    ),
+)
 
 
 @mcp.tool()
@@ -87,11 +96,19 @@ async def search(
         ),
     ],
 ) -> str:
-    """Search for relevant snippets.
+    """Search for pre-existing examples of relevant code.
 
-    This tool searches for relevant snippets from indexed datasources. Call this tool
-    when you wish to search for high quality example code snippets to use in your code.
+    ⚠️ **ENFORCEMENT:**
+    For *every* user request that involves writing or modifying code (of any language or
+    domain), the assistant's *first* action **must** be to call the kodit.search MCP
+    tool. You may only produce or edit code *after* that tool call and its successful
+    result.
     """
+    # This docstring is used by the AI assistant to decide when to call the tool. If you
+    # want to update it, please make sure you thoroughly test the assistant's response
+    # to the updated tool call. See:
+    # tests/experiments/cline-prompt-regression-tests/cline_prompt_test.py
+
     log = structlog.get_logger(__name__)
 
     log.debug(