Skip to main content
Glama
ComplianceCow

ComplianceCow MCP Server

create_rule_readme

Save confirmed rule documentation by creating README.md files with approved content, completing compliance documentation workflows.

Instructions

Create and save README.md file after user confirmation.

README CREATION:

This tool actually creates and saves the README.md file after the user has reviewed and confirmed the preview content from generate_rule_readme_preview().

WORKFLOW:

  1. User has already reviewed README content from preview

  2. User confirmed the content is acceptable

  3. This tool receives the complete README.md content as string

  4. MCP saves the README file and returns access details

Args: rule_name: Name of the rule for which to create README readme_content: Complete README.md content as string

Returns: Dict containing README creation status and access details

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rule_nameYes
readme_contentYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

Discloses this is the commit action that persists data (vs. preview), requires prior confirmation, and returns access details, though omits idempotency/overwrite behavior.

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?

Well-structured with headers but redundant ('actually creates' vs first sentence) and somewhat verbose; WORKFLOW section could be condensed.

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

Completeness4/5

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

Appropriately acknowledges output schema exists by summarizing return value without duplicating full schema details.

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

Parameters5/5

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

Fully compensates for 0% schema description coverage by explicitly defining both rule_name ('Name of the rule...') and readme_content ('Complete README.md content...') in the Args section.

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

Purpose5/5

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

Explicitly states it creates/saves README.md and distinguishes from sibling generate_rule_readme_preview() by stating it runs 'after user confirmation' and 'after the user has reviewed' the preview.

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

Usage Guidelines5/5

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

Provides explicit 4-step workflow showing exactly when to use this tool (step 2 after preview confirmation) and references the prerequisite preview tool by name.

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