qodo-get-relevant-rules

分类: 开发与编程 | 上传者: qodo-ai | 下载: 0 | 版本: v1.0（最新）

Fetches the most relevant coding rules from Qodo for the current coding task by generating a semantic search query from the assignment and calling the platform's search endpoint. Use this in place of qodo-get-rules when you have a specific coding task and want targeted rules rather than all rules.

更新日志: Source: GitHub https://github.com/qodo-ai/qodo-skills

目录结构

当前层级: skills/qodo-get-relevant-rules/

📁 references/
- 📄 query-generation.md 17.6 KB
- 📄 repository-scope.md 515 B
- 📄 search-endpoint.md 4.8 KB
📄 AGENTS.md 3.3 KB
📄 SKILL.md 7.0 KB

SKILL.md

---
name: qodo-get-relevant-rules
description: "Fetches the most relevant coding rules from Qodo for the current coding task by generating a semantic search query from the assignment and calling the platform's search endpoint. Use this in place of qodo-get-rules when you have a specific coding task and want targeted rules rather than all rules."
allowed-tools: ["Bash"]
triggers:
  - "get.?relevant.?rules"
  - "relevant.?rules"
  - "search.?rules"
  - "find.?relevant.?rules"
  - "qodo.?relevant"
  - "qodo.?search.?rules"
---

# Get Qodo Relevant Rules Skill

## Description

Searches for the most relevant Qodo coding rules for the current coding task. Instead of loading all rules, this skill generates a focused search query from the coding assignment and calls `POST /rules/search` to retrieve only the rules most relevant to the task at hand.

**Use** when you have a specific coding task and want targeted, ranked rules. This is the semantic-search alternative to `qodo-get-rules`.

**Skip** if "Qodo Rules Loaded" already appears in conversation context.

---

## Workflow

### Step 1: Check if Rules Already Loaded

If rules are already loaded (look for "Qodo Rules Loaded" in recent messages), skip to Step 6.

### Step 2: Verify Working in a Git Repository

- Check that the current directory is inside a git repository. If not, inform the user that a git repository is required and exit gracefully.

See [repository scope detection](references/repository-scope.md) for the git check command.

### Step 3: Verify Qodo Configuration

Check that the required Qodo configuration is present. The default location is `~/.qodo/config.json`.

- **API key**: Read from `~/.qodo/config.json` (`API_KEY` field). Environment variable `QODO_API_KEY` takes precedence. If not found, inform the user that an API key is required and provide setup instructions, then exit gracefully.
- **Environment name**: Read from `~/.qodo/config.json` (`ENVIRONMENT_NAME` field), with `QODO_ENVIRONMENT_NAME` environment variable taking precedence. If not found or empty, use production.
- **API URL override** (optional): Read from `~/.qodo/config.json` (`QODO_API_URL` field). If present, use `{QODO_API_URL}/rules/v1` as the API base URL, ignoring `ENVIRONMENT_NAME`. If absent, the `ENVIRONMENT_NAME`-based URL is used.
- **Request ID**: Generate a UUID (e.g. `python3 -c "import uuid; print(uuid.uuid4())"`) to use as `request-id` for the API call.

### Step 4: Generate Structured Search Queries from Coding Assignment

Generate **two structured search queries** that mirror the rule embedding format. The query quality directly determines retrieval quality.

Each query must use this exact three-line structure:

```
Name: {concise 5-10 word title of the rule this task would trigger}
Category: {one of: Security, Correctness, Quality, Reliability, Performance, Testability, Compliance, Accessibility, Observability, Architecture}
Content: {1-2 sentences describing what should be checked or enforced}
```

**Query 1 (Topic query):** Focused on the coding assignment's primary concern. Pick the most relevant Category and describe the specific check in Content. When the repository's tech stack is known, mention it in the Content field.

**Query 2 (Cross-cutting query):** Targets recurring quality and standards patterns that apply to most code changes. Choose Category based on the org's rule emphasis (Security, Compliance, Observability, or Architecture as default) — see query-generation.md for the full selection rules. Include concerns like module structure, type annotations, structured logging, and repository patterns in Content. Adjust Content to reflect the repository's tech stack when known.

This dual-query approach ensures retrieval of both topic-specific rules and cross-cutting quality rules that apply to nearly all code changes.

**Do not** generate queries in these formats -- they perform poorly with the embedding model:
- Keyword list: `authentication login JWT token Python FastAPI`
- Flat sentence: `Adding a login authentication endpoint with JWT token credential validation`

See [query generation guidelines](references/query-generation.md) for the full strategy, category descriptions, and examples.

### Step 5: Call POST /rules/search

Call the search endpoint **once per query** (topic query and cross-cutting query), each with `top_k=20`. Merge the results and deduplicate by rule ID, preserving the order from the topic query first, then filling from cross-cutting results. **Cap the final merged list at 15-20 unique rules** to avoid rule fatigue — if the combined set exceeds 20, truncate at 20, keeping topic results prioritized. When your tooling supports parallel execution (e.g., Claude Code parallel tool calls), run both calls in parallel to avoid added latency.

See [search endpoint](references/search-endpoint.md) for the full request/response contract, `top_k` defaults, error handling, and API URL construction.

### Step 6: Format and Output Rules

- Print the "📋 Qodo Rules Loaded" header with the search query used and total rule count.
- List rules in the order returned (they are already ranked by relevance):
  - Each rule: `- **{name}** [{severity}]: {content}`
- End output with `---`.

**Header format:**
```
# 📋 Qodo Rules Loaded

Search query: `{SEARCH_QUERY}`
Rules loaded: **{TOTAL_RULES}** (ranked by relevance to your task)

These rules must be applied during code generation based on severity:
```

If no rules were returned, output:
```
# 📋 Qodo Rules Loaded

No relevant rules found for this task. Proceeding without rule constraints.

---
```

Do **not** crash or error — an empty result is valid.

### Step 7: Apply Rules

Apply the returned rules to the coding task. Rules are returned ranked by relevance — apply all returned rules.

Inform the user about rule application after code generation:
- **Rules applied**: List which rules were followed
- **No applicable rules**: Inform: "No Qodo rules were applicable to this code change"

---

## Configuration

See [README.md](../../README.md#configuration) for full configuration instructions, including API key setup and environment variable options.

---

## Common Mistakes

- **Re-running when rules are loaded** - Check for "Qodo Rules Loaded" in context first
- **Wrong query format** - Write queries using the structured Name/Category/Content format, not keyword lists or flat sentences; the embedding model aligns best when the query mirrors the indexed structure
- **Single query only** - Always generate both a topic query and a cross-cutting query; a single topic-focused query misses cross-cutting rules (architecture, quality, observability) that apply to most code changes
- **Vague query** - The search query must capture the nature of the task; a generic Name or Content field returns irrelevant rules
- **Crashing on empty results** - An empty rules list is valid; proceed without rule constraints
- **Not in git repo** - Inform the user that a git repository is required and exit gracefully
- **No API key** - Inform the user with setup instructions; set `QODO_API_KEY` or create `~/.qodo/config.json`

登录后下载/点赞/收藏 ❤ 8 | ★ 0

qodo-get-relevant-rules

目录结构

SKILL.md

举报内容

提示