Repository navigation
docs(runtime): use the MCP tool names in the README - #225
Merged
Jesus Talavera (jesus-talavera-ibm) merged 2 commits intoOct 7, 2026
Merged
Jesus Talavera (jesus-talavera-ibm) merged 2 commits into
Jesus Talavera (jesus-talavera-ibm) merged 2 commits into
Conversation
The 20 tools register with a _tool suffix, but the API Reference headings, the Async Usage (MCP Server) example and the get_job_results workflow used the library names. Rename them to the names clients see in tools/list and add one line pointing to the library functions. Fixes Qiskit#224 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Vishal Habib (vishalhabib99)
requested review from
Juan Cruz-Benito (cbjuan),
Jesus Talavera (jesus-talavera-ibm) and
//va (vabarbosa)
as code owners
October 6, 2026 00:10
|
|
//va (vabarbosa)
left a comment
//va (vabarbosa)
left a comment
Collaborator
There was a problem hiding this comment.
thank you Vishal Habib (@vishalhabib99)
the changes look good. it is appreciated if can you please sign the CLA.
Jesus Talavera (jesus-talavera-ibm)
requested changes
Oct 6, 2026
- Option C and the credential order use setup_ibm_quantum_account_tool - Rename "Async Usage (MCP Server)" to "Async Usage (Library)" and restore the library function names in that block - Note that hosts can prefix tool names before writing allowlists Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Author
|
Jesus Talavera (@jesus-talavera-ibm) thanks for checking all 20 decorators. I applied all four suggestions in eaf6da0:
//va (@vabarbosa) thanks, I'll sign the CLA. |
Jesus Talavera (jesus-talavera-ibm)
approved these changes
Oct 7, 2026
Jesus Talavera (jesus-talavera-ibm)
left a comment
Jesus Talavera (jesus-talavera-ibm)
left a comment
Contributor
There was a problem hiding this comment.
LGTM. Thanks Vishal Habib (@vishalhabib99) !
//va (vabarbosa)
approved these changes
Oct 7, 2026
//va (vabarbosa)
left a comment
//va (vabarbosa)
left a comment
Collaborator
There was a problem hiding this comment.
thank you! Vishal Habib (@vishalhabib99)
Jesus Talavera (jesus-talavera-ibm)
merged commit Oct 7, 2026
bd1f16f
into
Qiskit:main
41 of 49 checks passed
10 of 14 tasks
Contributor
Author
|
Thanks Jesus Talavera (@jesus-talavera-ibm) and //va (@vabarbosa) for the careful review, especially checking all 20 decorators. Glad the README now matches what clients see in |
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
4 participants
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.
Description
Follows the option chosen in #224: the README now uses the MCP tool names (with the
_toolsuffix) that clients see intools/list._toolnames, plus one line at the top pointing to the library functions inqiskit_ibm_runtime_mcp_server.ibm_runtime(documented under Sync Usage)._toolnames.get_job_resultsworkflow example:get_job_status/get_job_resultsnow matchrun_sampler_toolin the same snippet.circuits://bell-state:run_sampler→run_sampler_tool.get_backend_properties_tool,list_saved_accounts_tool) renamed the same way.Sync Usage is unchanged, since it imports the library functions.
Linked Issue(s)
Fixes #224
Type of change
How Has This Been Tested?
Docs-only. I checked that the set of
####tool headings is exactly the set of@mcp.toolfunctions insrc/qiskit_ibm_runtime_mcp_server/server.py(20 for 20, no extras or misses), and that no library name without the suffix is left in the Async Usage example or the Tools section.Checklist:
🤖 Generated with Claude Code