docs: agent documentation review pass (LFXV2-2468)#101
Open
emsearcy wants to merge 2 commits into
Open
Conversation
- Remove DEVELOPER.md (no unique information was missing from AGENTS.md; the flag+env table, stdio OAuth note, and curl example have been preserved in AGENTS.md where needed) - Replace hardcoded Go and SDK versions with references to go.mod - Replace env-var-only table with combined flag+env table - Add stdio OAuth limitation note to Prerequisites - Remove Expected JSON-RPC Messages sub-section (pedantic, hard to keep current) - Remove Future Extensions section (describes tools already implemented) - Remove Debugging Tips section (duplicated the Logging section and used log.Printf which is the wrong pattern) - Fix SDK reference URL to point to main branch instead of pinned tag - Fix directory tree to reflect actual internal/ subdirectories Assisted-by: github-copilot:claude-sonnet-4.6 Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
Onboard the repository to GitHub Copilot cloud agent with instructions covering CI rules (license headers, MegaLinter checks), project layout, tool-adding patterns, key conventions, and common pitfalls. Assisted-by: github-copilot:claude-opus-4.6 Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
emsearcy
changed the title
| go version | ||
| ``` | ||
|
|
||
| > **Note:** The stdio transport only exposes the `hello_world` tool. All LFX data tools require OAuth authentication, which is only supported via the HTTP transport. There is currently no personal access token (PAT) capability in LFX, so running the full server locally for end-to-end use is not practical without a complete OAuth setup. |
|
|
||
| - Forgetting the license header on new files is the #1 cause of CI failure. | ||
| - New `.go` files without a package doc comment will fail the revive `package-comments` rule. | ||
| - The `defaultTools` list in `main.go` controls which tools are enabled; adding a Register call without adding the name to `defaultTools` means the tool is never active. |
| ├── cmd/ | ||
| │ └── lfx-mcp-server/ # Main application entry point | ||
| ├── internal/ | ||
| │ ├── auth/ # OAuth token exchange and JWT validation |
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.
Summary
This PR completes a review pass on agent documentation in the lfx-mcp repo (LFXV2-2468), covering three tasks:
1. Remove
DEVELOPER.mdRemoved
DEVELOPER.mdafter verifying it contained no information missing fromAGENTS.md. Preserved the flag+env table, stdio OAuth limitation note, and curl example inAGENTS.mdwhere appropriate.2. Review and refresh
AGENTS.mdgo.modmainbranchinternal/subdirectories3. Add
.github/copilot-instructions.mdfor Copilot cloud agentOnboards the repository for GitHub Copilot cloud code reviews. Scoped to what a cloud agent needs to generate correct PRs without exploring the repo each time: CI rules (license header, active MegaLinter checks vs. disabled ones), project layout, tool-adding pattern, key conventions, and common pitfalls. Local developer workflow remains in
AGENTS.md.Jira: LFXV2-2468
🤖 Generated with GitHub Copilot (via OpenCode)