Skip to main content

Non-functional rules

A non-functional rule is a document your agents read before they start work: a coding standard, an architecture constraint, a security requirement, a naming convention. Vindex stores the Markdown and hands it to your agents as it is written. Nothing is checked against it, it is always private, and it uses no critique credits. For what it is for, see Engineering standards.

Two types of rule

A rule has a type, set when the rule is created. It cannot be changed afterwards, so to convert a rule, create a new one. A rule created with no type is functional.

Functional and non-functional rules compared
Functional ruleNon-functional rule
What the Markdown is forRequirements a finished output is checked againstRequirements an agent reads before it starts
When the agent meets itAfter the work, through validateBefore the work, through get_non_functional_rules
FormatRule formatAny Markdown. No format to follow
Pass barRequiredNone
Version statusesDraft, test, active, archivedDraft, active, archived
VisibilityPrivate or publicPrivate only
validateRuns it and uses creditsRefused. Nothing is charged
CostReading is free. A critique uses creditsFree

Create one

  • In your portal. In Agent Rules, start a new rule and choose Non-functional as its type, then upload the Markdown file. There is no pass bar to set.
  • Through your agent. create_rule takes type non_functional with the Markdown as text. Sending a pass bar is refused.

The rule is saved as a draft with a title, a description, and tags. Its slug is made from the title and never changes, and no two of a company’s non-functional rules share a slug. A title that would repeat one is refused.

Versions and statuses

  • Each upload is a new version. A version never changes after it is saved, and earlier versions stay readable.
  • A version is a draft until it is made active. It can be made active as soon as it is saved.
  • A rule has one active version. Making a version active archives the one that was active before, in the same step.
  • There is no test status. Test means a critique can be pointed at the version, and a non-functional rule is never checked.
  • Agents are handed active versions only. A draft is never returned by get_non_functional_rules.

Any active member of your company can create a non-functional rule and make a version active, in the portal or through an agent. Making a version active changes what the company’s agents read before they work, so set_rule_version_status is marked as a destructive tool, and a client that asks before destructive tools asks the person first.

Sets

A set groups the documents one kind of codebase needs, such as Backend standards holding Python style, API conventions, and Logging and PII. A set is a rule whose version nests at least two other rules, and a set can hold other sets.

  • A set holds one type. A non-functional set nests only non-functional rules, and a functional rule set only functional ones.
  • Each nested rule is read at its active version. Activating a new version of a document changes what the set returns, with no change to the set.
  • A set can carry Markdown of its own. It is then returned as a document too, ahead of the rules it nests.

Read them: get_non_functional_rules

One call returns the documents with their Markdown. Any active member of the company can call it. It is free and read-only.

Inputs of get_non_functional_rules
InputWhat it does
NoneReturns every active non-functional rule the company owns that has Markdown of its own, ordered by title.
slugOne rule or set by its slug, such as backend-standards: lowercase letters, digits, and hyphens. For a set, the answer is its own Markdown and then each rule it nests, all the way down, each rule once, in the order the set lists them.
ruleIdThe same rule or set by its ID. Send slug or ruleId, never both.
tagsNarrows any of the calls above to the rules that carry every tag listed, matched exactly.
page, pageSizePaging. 20 documents a page by default, 100 at most.

To let the agent choose, it lists the titles, descriptions, and tags with list_rules and type non_functional, which returns no content, then reads the ones it picked. list_rules lists functional rules unless a type is given.

What comes back

What get_non_functional_rules returns
FieldWhat it is
dataThe documents. Each has ruleId, slug, title, description, tags, versionId, versionNumber, modifiedAt, and content, the Markdown.
parentRuleIdOn each document: the set that brought it in. Empty for a rule asked for directly.
leftOutRulesNested rules that could not be used, each with a reason: unavailable, disabled, archived, or not_ready. A nested rule with no active version is unavailable.
paginationThe page, the page size, and the totals.

A set is never refused for having too few usable rules. If one document in it can be read, that document is returned and the rest are named as left out.

Refusals

Refusals of get_non_functional_rules
WhenWhat the agent is told
The slug or ID is unknown, belongs to another company, or names a functional ruleNo non-functional rule with that slug or ID is in the company's catalog.
Both slug and ruleId were sentSend one, not both.
The rule has no active versionThere is nothing to read yet. Make a version active.
The rule is disabled or archivedThe rule cannot be used.

Tell the agent to read them

The Vindex MCP server’s instructions tell a connected agent to call get_non_functional_rules before it writes or changes code, and to follow what it returns. A server cannot make a client call a tool, so name the set in the repository as well. Add this to the file your client reads for standing instructions, such as CLAUDE.md, AGENTS.md, or .cursor/rules, with the slug of the set for that codebase.

In the repository's agent instructions
markdown
## Engineering standards

Before you write or change code in this repository, call
get_non_functional_rules with slug "backend-standards" and follow
what it returns while you work.

These are requirements to read. Do not pass them to validate.

A slug never changes, so the line stays right when the documents in the set do. Connect your agent covers the connection for each client.

Checking

A non-functional rule cannot be checked. validate refuses one before any credit is held, with this message:

This is a non-functional rule. It is read before work starts and cannot be checked. Nothing was charged.

For a standard you want checked on what an agent writes, write a functional rule for it and run a critique.

Private only

  • A non-functional rule is always private. It has no publish action, in the portal or anywhere else.
  • It never appears in the Rules marketplace or in any public listing, and another company cannot add it to its catalog.
  • To another company it does not exist: asking for it by ID or slug returns “not found”.
  • Vindex stores the Markdown and returns it to your company’s own agents. It is not sent to a model for preparation or review.

What it does not do

  • It does not check code, or anything else, against a non-functional rule.
  • It does not return part of a document or search inside one. A read returns whole documents.
  • It does not sync documents from a git repository or a wiki. They are uploaded, as rules are.
  • It does not keep a report of which agent read which document.
  • It does not mix types. A set of non-functional rules cannot hold a rule that is checked.