Skip to main content
Glama

Governance Ir Appendix

governance_ir_appendix
Read-onlyIdempotent

Export an aggregate-only markdown IR appendix for the selected project. Excludes raw conversation, context package body, recall answer text, and evidence quote payloads.

Instructions

Use when: Human governance tool: export an aggregate-only markdown IR appendix for the selected project. Raw conversation, context package body, recall answer text, and evidence quote payloads are excluded by the API. Do not use when: a narrower tool better matches the intent, the project scope is unresolved, or the user has declined the action. Requires: authenticated API authority and an API-authorized selected Project. Effect: read. Human approval: not required for this read or staging action. Then: follow typed result state; review pending proposals/drafts before any canonical apply. On failure: login_required → login; project_not_selected → list_projects/select_project; permission_denied → stop; stale_version or conflict → read current state; projection_pending → report canonical success separately and wait.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdNoOptional project id. Defaults to the project chosen with select_project. If omitted and no project is selected, the call is rejected with instructions to select one.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
statusYes
warningsYes
authorityYes
projectIdYes
reviewUrlYes
idempotencyYes
nextActionsYes
reviewRequiredYes
canonicalVersionYes
projectionStatusYes
Behavior5/5

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

Annotations indicate readOnlyHint=true and destructiveHint=false, and the description adds that the effect is read, raw data is excluded, and details failure handling (e.g., login_required, stale_version). No contradiction with annotations.

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

Conciseness5/5

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

The description is structured with clear sections (Use when, Do not use when, etc.) and front-loaded with key information. Every sentence adds value without redundancy.

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

Completeness5/5

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

Given the low parameter count, presence of output schema, and rich annotations, the description covers purpose, usage, behavior, error handling, and follow-up steps comprehensively.

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?

Schema coverage is 100% with one optional parameter. The description adds context on default behavior (project selection) and rejection scenario, enhancing understanding beyond the schema.

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?

The description clearly states the tool exports an aggregate-only markdown IR appendix for the selected project. It uses specific verb 'export' and identifies the resource, though it does not explicitly differentiate from sibling tools beyond the context of being a governance tool.

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?

The description explicitly provides 'Use when' and 'Do not use when' conditions, lists requirements, and specifies human approval needs. This gives clear guidance on when to invoke this tool versus alternatives.

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/my-abyss-project/abyss-mcp'

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