Skip to content

Document beta status and add a caution about write actions to the README #23

Description

@dangrondahl

Description

The README says nothing about the server being beta, and nothing about the care write actions deserve. Both matter more once the repo is public and the package is installable by people who've never spoken to us.

Confirmed missing today: no occurrence of "beta" or "experimental" anywhere in README.md, and the only mention of writes is line 9 — "requires approval in MCP clients" — which states the mechanism without saying why it exists.

1. Beta status

We're at 0.4.0, pre-1.0, published to npm and distributed as a .mcpb bundle. Nothing tells a new user the interface may still change. Proposed note near the top of the README:

Warning

This server is in beta. Tool names, parameters, and behaviour may change between releases. Pin a version if you need stability.

2. Write actions deserve a real warning

execute_write_action reaches every non-GET endpoint in the catalog. As of today that's 51 of 118 actions — 25 PUT, 18 POST, 5 DELETE, 3 PATCH — including delete_service_account and delete_service_account_api_key, either of which can revoke credentials that other systems depend on.

The MCP approval prompt is the only checkpoint between a model's suggestion and a real API call. An LLM can pick a plausible-but-wrong action, or the right action with wrong parameters, and the prompt will look much the same either way. Proposed note in the Usage section:

Important

execute_write_action creates, modifies, and deletes real resources in your Kosli organization. MCP clients gate these calls behind an approval prompt — read the action ID and parameters before approving. An LLM may select the wrong action or the wrong parameters, and approval is the only checkpoint before the call is made. Treat deletions and anything touching service accounts or API keys with particular care.

Tasks

  • Add the beta notice to README.md
  • Add the write-action caution to the Usage section of README.md
  • Decide whether the beta status also belongs in package.json description and manifest.json (shown in Claude Desktop's UI at install time)

Notes

The counts above come from src/catalog.json and will drift as the catalog is regenerated, so the README wording deliberately avoids hard numbers.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions