Skip to main content
Glama

Share knowledge

share_knowledge
Destructive

Share a knowledge file or folder with a specific user. Creates a per-user access grant. The shared user's agent will also be able to read the files. Use when sharing reference docs — not a Play or Playbook (those are create_playbook / list_playbooks; this does not clone a Playbook onto another company).

[write-tier — first use may require a manager's approval; a from-now-on approval makes future calls seamless, a just-once approval re-asks next time. Call it on the first clear ask; the card is the yes — do not re-ask in chat.]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesThe file or folder path to share. Use trailing "/" for folders (e.g., "acme-deal/") — nested folders work too (e.g., "partners/acme/" shares the whole subtree). Use no trailing "/" for files (e.g., "acme-deal/term-sheet").
companyIdYesFreedomOS company id to act within (you must be a member). Required for company-scoped tools.
permissionNoPermission level: "read" (default) or "write".
user_emailYesEmail of the FreedomOS user to share with.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / path / description
      Previous value: -"The file or folder path to share. Use trailing \"/\" for folders (e.g., \"acme-deal/\"). Use no trailing \"/\" for files (e.g., \"acme-deal/term-sheet\")."New value: +"The file or folder path to share. Use trailing \"/\" for folders (e.g., \"acme-deal/\") — nested folders work too (e.g., \"partners/acme/\" shares the whole subtree). Use no trailing \"/\" for files (e.g., \"acme-deal/term-sheet\")."
  2. Changed1 schema field changed
    • changedInput schema / properties / path / description
      Previous value: -"The file or folder path to share. Use trailing \"/\" for folders (e.g., \"conduit-deal/\"). Use no trailing \"/\" for files (e.g., \"conduit-deal/term-sheet\")."New value: +"The file or folder path to share. Use trailing \"/\" for folders (e.g., \"acme-deal/\"). Use no trailing \"/\" for files (e.g., \"acme-deal/term-sheet\")."
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

The annotations already signal mutation (readOnlyHint=false, destructiveHint=true). The description adds useful behavioral context beyond that: creating a per-user access grant, that the shared user's agent can read the files, and the approval/consent behavior. It doesn't cover revocability or idempotency, but the added context is meaningful.

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 core purpose is front-loaded, followed by clear usage boundaries and approval guidance. Every sentence earns its place — the Play/Playbook exclusion and write-tier approval note are operationally important, not filler.

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?

For a mutation tool with no output schema, the description covers the purpose, scope, exclusions, and approval flow. It does not mention how to undo the grant or point to unshare_knowledge, but the essential information for selecting and invoking the tool is present.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema fully documents all four parameters including path trailing-slash conventions, permission enum, companyId scoping, and user_email. The description adds no additional parameter-level detail, so the baseline of 3 applies.

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?

The description opens with a specific verb and resource: 'Share a knowledge file or folder with a specific user. Creates a per-user access grant.' It differentiates from sibling tools by explicitly excluding Plays/Playbooks and even names create_playbook/list_playbooks as the alternatives.

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?

Gives explicit when-to-use guidance: 'Use when sharing reference docs — not a Play or Playbook.' It also explains what the tool is not for and provides the write-tier approval workflow instructions, so an agent knows exactly when to call it and how to handle approval.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources