Skip to main content
Glama
ComplianceCow

ComplianceCow MCP Server

update_rule_readme

Update README.md files for compliance rules with revised content to reflect policy changes and evolving documentation requirements.

Instructions

Update existing README.md file with new content.

README UPDATE:

This tool updates an existing README.md file with new content. Useful for making changes after initial creation or updating documentation as rules evolve.

Args: rule_name: Name of the rule for which to update README updated_readme_content: Updated README.md content as string

Returns: Dict containing README update status and details

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rule_nameYes
updated_readme_contentYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Clarifies it works on 'existing' files (implying pre-existence requirement) and describes return type, but omits edge cases (e.g., behavior if rule doesn't exist) and idempotency details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Contains redundant opening sentences ('Update existing...' repeated in header and body) though Args/Returns structure improves scannability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers basic operation and return value for this simple two-parameter tool, but lacks error handling documentation or preconditions (e.g., rule must exist).

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Effectively compensates for 0% schema description coverage by providing clear inline definitions for both rule_name and updated_readme_content parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States specific action (update) and resource (README.md file), with implicit distinction from sibling create_rule_readme via 'after initial creation' phrase.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides implied context ('after initial creation') but lacks explicit when-not-to-use guidance or direct comparison to create_rule_readme alternative.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ComplianceCow/cow-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server