[#104] Fix documentation gaps and inaccuracies#105
[#104] Fix documentation gaps and inaccuracies#105Sakshii-27 wants to merge 1 commit intopgmoneta:mainfrom
Conversation
|
|
||
| Open a chat (Ctrl + Alt + I) and try: | ||
| - "Say hello to the pgmoneta MCP server" | ||
| - "List all backups for server primary" |
There was a problem hiding this comment.
Now, that is double - we should rewrite and use pgmoneta-mcp-client instead
| - Ask: "Say hello to the pgmoneta MCP server" | ||
| - Expected response: "Hello from pgmoneta MCP server!" | ||
| - Ask: "List all backups for server primary" | ||
| - Expected response: A list of backups in JSON format (or an empty list if none exist) |
There was a problem hiding this comment.
Lets use the output from pgmoneta-mcp-client
Sakshii-27
force-pushed
the
cors-and-doc-gaps
branch
from
daeece1 to
5d61e39
Compare
|
@jesperpedersen PTAL |
| Make sure that [**pgmoneta_mcp**][pgmoneta_mcp] is installed and in your path by using `pgmoneta-mcp-server --help`. You should see | ||
|
|
||
| ``` console | ||
| pgmoneta-mcp-server 0.2.0 |
There was a problem hiding this comment.
Why is this changed ? That is wrong
There was a problem hiding this comment.
The changes to the documentation were made because the pgmoneta-mcp-server binary was producing output that differed from the manual (it used --conf instead of --config, had a longer description, and the command name in the help text was missing the -server suffix).
Should I update server.rs to match the original documented output (--config, shorter about text, correct name)?
| -u, --users <USERS> Path to users file [default: /etc/pgmoneta-mcp/pgmoneta-mcp-users.conf] | ||
| -h, --help Print help | ||
| -V, --version Print version | ||
| -c, --conf <CONF> Path to pgmoneta MCP configuration file [default: /etc/pgmoneta-mcp/pgmoneta-mcp.conf] |
There was a problem hiding this comment.
We don't need pgmoneta MCP here
| You can see the commands it supports by using `pgmoneta-mcp-admin --help` which will give: | ||
|
|
||
| ``` console | ||
| pgmoneta-mcp-admin 0.2.0 |
There was a problem hiding this comment.
here too change was made because the pgmoneta-mcp-admin binary was producing output that differed from the manual (e.g., using "Manage a specific user" instead of "Manage users" and a different help format). I updated the documentation to match the binary's actual output.
should I updated the source code admin.rs to match the documentation instead?
| The **pgmoneta-mcp-admin** command line interface manages your users for [**pgmoneta-mcp**](https://github.com/pgmoneta/pgmoneta-mcp). | ||
|
|
||
| ``` | ||
| pgmoneta-mcp-admin |
2 participants
This PR fixes inaccuracies in the manual, including incorrect port numbers, outdated configuration sections, and non-existent tool examples. It also adds documentation for CORS support and browser-based client connectivity to ensure the manual matches the current codebase.
Closes #104