Add documentation endpoint for information about operations to create MCP possiblities#78
Open
GhostDog98 wants to merge 3 commits intogchq:masterfrom
Open
Add documentation endpoint for information about operations to create MCP possiblities#78GhostDog98 wants to merge 3 commits intogchq:masterfrom
GhostDog98 wants to merge 3 commits intogchq:masterfrom
Conversation
Changed email associated with commit
updated swagger, changed email
Contributor
Author
|
Apologies for the delay and force push rebase, I had to change the username i signed my commits with. |
Contributor
Author
|
I'll be closing this for the time being due to #79 as that is far more pressing. Will reopen one that gets merged. |
Contributor
|
Reopening as #79 has now been merged. |
Contributor
Author
|
Cheers! I'll probably have another look over this PR on monday and triple check everything works as expected with my changes introduced in #79 :) |
GCHQDeveloper581
requested changes
Feb 11, 2026
Contributor
GCHQDeveloper581
left a comment
There was a problem hiding this comment.
Could you fix the linting error please?
Otherwise looks good.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a new endpoint,
/docs.The description for this endpoint is: "Given the name of an operation, returns a json-formatted string containing the operation's documentation. The endpoint does not return documentation for any operations that may be called by the specified operation (for example, operations called by a "Magic" operation)."
An example request may look like:
And a sample response:
[ { "module": "Crypto", "description": "MD5 (Message-Digest 5) is a widely used hash function. It has been used in a variety of security applications and is also commonly used to check the integrity of files.<br><br>However, MD5 is not collision resistant and it isn't suitable for applications like SSL/TLS certificates or digital signatures that rely on this property.", "infoURL": "https://wikipedia.org/wiki/MD5", "inputType": "ArrayBuffer", "outputType": "string", "flowControl": false, "manualBake": false, "args": [], "name": "MD5" } ]My motivation for this PR is that this would allow an LLM to use cyberchef as a managed context protocol provider very easily, which would greatly improve its abilities.