Skip to main content
Glama
Sign In
okf-tools

okf-tools

by hdean-ssp
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

init_bundle

Sets up a new OKF knowledge bundle by creating configuration files, a root index, and updating .gitignore for version control.

Instructions

Initialize a new OKF knowledge bundle at the specified path.

Creates .okf/config.json, a root index.md, and updates .gitignore if in a git repo. This is the only tool that does not require a pre-configured bundle.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "init_bundle"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNo.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations provided, so description carries full burden. It discloses file creation and gitignore update, but lacks details on idempotency, overwriting behavior, or side effects. Generally adequate but not thorough.

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?

Two concise sentences: first states purpose, second lists actions and special condition. No wasted words, front-loaded with key information.

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?

Description covers main purpose and unique trait, but given the lack of annotations and presence of an output schema, it could mention return value or error conditions. Adequate for a simple tool, but not fully complete.

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

Parameters2/5

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

Schema description coverage is 0%, so description must compensate for the single 'path' parameter. Description only mentions 'at the specified path' without clarifying format, existence, or validation requirements, providing minimal value beyond the schema.

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?

Description clearly states 'Initialize a new OKF knowledge bundle' with specific verb and resource, lists created files, and highlights it is the only tool not requiring a pre-configured bundle, distinguishing it from siblings.

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

Usage Guidelines4/5

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

Explicitly notes it is the only tool that does not require a pre-configured bundle, implying use for new setups. However, no explicit when-not or alternatives are named, though sibling context provides some guidance.

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

Deploy Server

Other Tools