Skip to content

Commit 5fb7870

Browse files
docs(packages): make cli and mcp-server READMEs framework-agnostic
Remove 4D-specific framing from both package READMEs so they reflect that Fluently supports any registered collaboration framework, with the AI Fluency 4D Framework as the bundled default. Adds a Frameworks section to the CLI README explaining how to register additional frameworks. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 6722567 commit 5fb7870

2 files changed

Lines changed: 14 additions & 8 deletions

File tree

packages/cli/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# fluently-cli
22

3-
**CLI for the [Fluently 4D Framework](https://fluently-org.github.io/fluently/) — score, compare, and contribute human-AI collaboration cycles from your terminal.**
3+
**Terminal CLI for [Fluently](https://fluently-org.github.io/fluently/) — score, compare, and contribute human-AI collaboration cycles across any registered framework.**
44

5-
Works with any AI agent: Claude, GPT-4o, Gemini, Mistral, GitHub Copilot, and more.
5+
Framework-agnostic. Bundles the AI Fluency 4D Framework as the default. Works with any AI agent: Claude, GPT-4o, Gemini, Mistral, GitHub Copilot, and more.
66

77
[![npm version](https://img.shields.io/npm/v/fluently-cli.svg)](https://www.npmjs.com/package/fluently-cli)
88
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](../../LICENSE)
@@ -24,7 +24,7 @@ Requires Node.js 20+.
2424

2525
| Command | What it does |
2626
|---------|-------------|
27-
| `fluent score <task>` | Find the 3 most similar 4D cycles to a task description |
27+
| `fluent score <task>` | Find the 3 most relevant cycles from the knowledge base for a task |
2828
| `fluent compare --description <desc> --delegation <intent>` | Match a task + delegation intent to the closest cycle |
2929
| `fluent list [domain]` | Browse all cycles, optionally filtered by domain |
3030
| `fluent contribute` | Interactive wizard to build and validate a new cycle as YAML |
@@ -78,7 +78,7 @@ Available domains: `coding` · `writing` · `research` · `education` · `legal`
7878
fluent contribute
7979
```
8080

81-
The interactive wizard walks through each of the 4 dimensions, validates the result against the Zod schema, and writes a `.yaml` file ready to commit and PR to the community repo.
81+
The interactive wizard walks through each dimension of the chosen framework, validates the result against the Zod schema, and writes a `.yaml` file ready to commit and PR to the community repo.
8282

8383
### Sync — stay up to date
8484

@@ -90,9 +90,11 @@ Pulls the latest cycles from upstream. For a global npm install, use `npm update
9090

9191
---
9292

93-
## The 4D Framework
93+
## Frameworks
9494

95-
Every Fluently cycle covers four dimensions of human-AI collaboration:
95+
Fluently is framework-agnostic. Any collaboration framework with named dimensions can be registered. Each cycle carries a `framework_id` that determines which dimension fields it uses.
96+
97+
The **AI Fluency 4D Framework** is bundled as the default:
9698

9799
| Dimension | Question |
98100
|-----------|----------|
@@ -101,6 +103,8 @@ Every Fluently cycle covers four dimensions of human-AI collaboration:
101103
| 👁️ **Discernment** | How do you evaluate and trust the AI output? |
102104
|**Diligence** | What accountability steps follow AI involvement? |
103105

106+
Additional frameworks can be added by contributing a YAML definition to `/frameworks/`. Cycles for that framework will be validated and scored against its own dimension schema automatically.
107+
104108
Browse the full community knowledge base at **[fluently-org.github.io/fluently/knowledge.html](https://fluently-org.github.io/fluently/knowledge.html)**.
105109

106110
---

packages/mcp-server/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# fluently-mcp-server
22

3-
**MCP server for the [Fluently 4D Framework](https://fluently-org.github.io/fluently/).** Exposes knowledge retrieval and contribution tools so any AI agent can find, reason over, and extend Fluently 4D cycles — without hardcoded scores.
3+
**MCP server for [Fluently](https://fluently-org.github.io/fluently/) — exposes knowledge retrieval and contribution tools so any AI agent can find, reason over, and extend collaboration cycles across any registered framework, without hardcoded scores.**
4+
5+
Framework-agnostic. Bundles the AI Fluency 4D Framework as the default. Any framework with named dimensions can be registered.
46

57
Works with Claude, GPT-4o, Gemini, Mistral, Llama, GitHub Copilot, Cursor, Cline, and any other MCP-compatible agent.
68

@@ -54,7 +56,7 @@ The same config block works for any MCP-compatible client. The server speaks std
5456
|------|---------|
5557
| `list_domains` | List available knowledge domains and cycle counts |
5658
| `find_relevant_cycles` | Retrieve ranked candidate cycles for a task — agent reasons, no false-precision scores |
57-
| `get_cycle_detail` | Full 4D cycle by ID (delegation · description · discernment · diligence) |
59+
| `get_cycle_detail` | Full cycle by ID — all dimension fields for its registered framework |
5860
| `get_dimension_guidance` | Antipatterns + examples for one dimension across all cycles |
5961
| `refresh_knowledge` | Re-fetch from the connector without restarting the server |
6062
| `contribute_cycle` | Validate a new cycle and submit it to the knowledge source |

0 commit comments

Comments
 (0)